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

Class CustomAudience.Builder

  • All Implemented Interfaces:
    CustomAudienceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    CustomAudience
    public static final class CustomAudience.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<CustomAudience.Builder>
implements CustomAudienceOrBuilder
     A custom audience. This is a list of users by interest.
    Protobuf type google.ads.googleads.v10.resources.CustomAudience

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

      • clear

        public CustomAudience.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<CustomAudience.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<CustomAudience.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public CustomAudience.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<CustomAudience.Builder>

      • setField

        public CustomAudience.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<CustomAudience.Builder>

      • clearField

        public CustomAudience.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<CustomAudience.Builder>

      • clearOneof

        public CustomAudience.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<CustomAudience.Builder>

      • setRepeatedField

        public CustomAudience.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<CustomAudience.Builder>

      • addRepeatedField

        public CustomAudience.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<CustomAudience.Builder>

      • mergeFrom

        public CustomAudience.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<CustomAudience.Builder>

      • isInitialized

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

      • mergeFrom

        public CustomAudience.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<CustomAudience.Builder>
        Throws:
        java.io.IOException

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

      • setResourceName

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

      • clearResourceName

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

      • setResourceNameBytes

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

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

      • setId

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

      • clearId

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

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

      • setStatusValue

        public CustomAudience.Builder setStatusValue​(int value)
         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];
        Parameters:
        value - The enum numeric value on the wire for status to set.
        Returns:
        This builder for chaining.

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

      • setStatus

        public CustomAudience.Builder setStatus​(CustomAudienceStatusEnum.CustomAudienceStatus value)
         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];
        Parameters:
        value - The status to set.
        Returns:
        This builder for chaining.

      • clearStatus

        public CustomAudience.Builder clearStatus()
         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];
        Returns:
        This builder for chaining.

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

      • setName

        public CustomAudience.Builder setName​(java.lang.String value)
         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;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public CustomAudience.Builder clearName()
         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;
        Returns:
        This builder for chaining.

      • setNameBytes

        public CustomAudience.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

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

      • setTypeValue

        public CustomAudience.Builder setTypeValue​(int value)
         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;
        Parameters:
        value - The enum numeric value on the wire for type to set.
        Returns:
        This builder for chaining.

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

      • setType

        public CustomAudience.Builder setType​(CustomAudienceTypeEnum.CustomAudienceType value)
         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;
        Parameters:
        value - The type to set.
        Returns:
        This builder for chaining.

      • clearType

        public CustomAudience.Builder clearType()
         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;
        Returns:
        This builder for chaining.

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

      • setDescription

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

      • clearDescription

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

      • setDescriptionBytes

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

      • 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

      • 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

      • setMembers

        public CustomAudience.Builder setMembers​(int index,
                                         CustomAudienceMember value)
         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;

      • setMembers

        public CustomAudience.Builder setMembers​(int index,
                                         CustomAudienceMember.Builder builderForValue)
         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;

      • addMembers

        public CustomAudience.Builder addMembers​(CustomAudienceMember value)
         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;

      • addMembers

        public CustomAudience.Builder addMembers​(int index,
                                         CustomAudienceMember value)
         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;

      • addMembers

        public CustomAudience.Builder addMembers​(CustomAudienceMember.Builder builderForValue)
         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;

      • addMembers

        public CustomAudience.Builder addMembers​(int index,
                                         CustomAudienceMember.Builder builderForValue)
         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;

      • addAllMembers

        public CustomAudience.Builder addAllMembers​(java.lang.Iterable<? extends CustomAudienceMember> values)
         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;

      • clearMembers

        public CustomAudience.Builder clearMembers()
         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;

      • removeMembers

        public CustomAudience.Builder removeMembers​(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;

      • getMembersBuilder

        public CustomAudienceMember.Builder getMembersBuilder​(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;

      • 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

      • 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

      • addMembersBuilder

        public CustomAudienceMember.Builder addMembersBuilder()
         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;

      • addMembersBuilder

        public CustomAudienceMember.Builder addMembersBuilder​(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;

      • getMembersBuilderList

        public java.util.List<CustomAudienceMember.Builder> getMembersBuilderList()
         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;

      • setUnknownFields

        public final CustomAudience.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<CustomAudience.Builder>

      • mergeUnknownFields

        public final CustomAudience.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<CustomAudience.Builder>