Package com.google.ads.googleads.v10.common

Class UserAttribute.Builder

  • All Implemented Interfaces:
    UserAttributeOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    UserAttribute
    public static final class UserAttribute.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<UserAttribute.Builder>
implements UserAttributeOrBuilder
     User attribute, can only be used with CUSTOMER_MATCH_WITH_ATTRIBUTES job
 type.
    Protobuf type google.ads.googleads.v10.common.UserAttribute

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

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

      • hasLifetimeValueMicros

        public boolean hasLifetimeValueMicros()
         Advertiser defined lifetime value for the user.
        optional int64 lifetime_value_micros = 1;
        Specified by:
        hasLifetimeValueMicros in interface UserAttributeOrBuilder
        Returns:
        Whether the lifetimeValueMicros field is set.

      • getLifetimeValueMicros

        public long getLifetimeValueMicros()
         Advertiser defined lifetime value for the user.
        optional int64 lifetime_value_micros = 1;
        Specified by:
        getLifetimeValueMicros in interface UserAttributeOrBuilder
        Returns:
        The lifetimeValueMicros.

      • setLifetimeValueMicros

        public UserAttribute.Builder setLifetimeValueMicros​(long value)
         Advertiser defined lifetime value for the user.
        optional int64 lifetime_value_micros = 1;
        Parameters:
        value - The lifetimeValueMicros to set.
        Returns:
        This builder for chaining.

      • clearLifetimeValueMicros

        public UserAttribute.Builder clearLifetimeValueMicros()
         Advertiser defined lifetime value for the user.
        optional int64 lifetime_value_micros = 1;
        Returns:
        This builder for chaining.

      • hasLifetimeValueBucket

        public boolean hasLifetimeValueBucket()
         Advertiser defined lifetime value bucket for the user. The valid range for
 a lifetime value bucket is from 1 (low) to 10 (high), except for remove
 operation where 0 will also be accepted.
        optional int32 lifetime_value_bucket = 2;
        Specified by:
        hasLifetimeValueBucket in interface UserAttributeOrBuilder
        Returns:
        Whether the lifetimeValueBucket field is set.

      • getLifetimeValueBucket

        public int getLifetimeValueBucket()
         Advertiser defined lifetime value bucket for the user. The valid range for
 a lifetime value bucket is from 1 (low) to 10 (high), except for remove
 operation where 0 will also be accepted.
        optional int32 lifetime_value_bucket = 2;
        Specified by:
        getLifetimeValueBucket in interface UserAttributeOrBuilder
        Returns:
        The lifetimeValueBucket.

      • setLifetimeValueBucket

        public UserAttribute.Builder setLifetimeValueBucket​(int value)
         Advertiser defined lifetime value bucket for the user. The valid range for
 a lifetime value bucket is from 1 (low) to 10 (high), except for remove
 operation where 0 will also be accepted.
        optional int32 lifetime_value_bucket = 2;
        Parameters:
        value - The lifetimeValueBucket to set.
        Returns:
        This builder for chaining.

      • clearLifetimeValueBucket

        public UserAttribute.Builder clearLifetimeValueBucket()
         Advertiser defined lifetime value bucket for the user. The valid range for
 a lifetime value bucket is from 1 (low) to 10 (high), except for remove
 operation where 0 will also be accepted.
        optional int32 lifetime_value_bucket = 2;
        Returns:
        This builder for chaining.

      • getLastPurchaseDateTime

        public java.lang.String getLastPurchaseDateTime()
         Timestamp of the last purchase made by the user.
 The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
 optional timezone offset from UTC. If the offset is absent, the API will
 use the account's timezone as default.
        string last_purchase_date_time = 3;
        Specified by:
        getLastPurchaseDateTime in interface UserAttributeOrBuilder
        Returns:
        The lastPurchaseDateTime.

      • getLastPurchaseDateTimeBytes

        public com.google.protobuf.ByteString getLastPurchaseDateTimeBytes()
         Timestamp of the last purchase made by the user.
 The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
 optional timezone offset from UTC. If the offset is absent, the API will
 use the account's timezone as default.
        string last_purchase_date_time = 3;
        Specified by:
        getLastPurchaseDateTimeBytes in interface UserAttributeOrBuilder
        Returns:
        The bytes for lastPurchaseDateTime.

      • setLastPurchaseDateTime

        public UserAttribute.Builder setLastPurchaseDateTime​(java.lang.String value)
         Timestamp of the last purchase made by the user.
 The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
 optional timezone offset from UTC. If the offset is absent, the API will
 use the account's timezone as default.
        string last_purchase_date_time = 3;
        Parameters:
        value - The lastPurchaseDateTime to set.
        Returns:
        This builder for chaining.

      • clearLastPurchaseDateTime

        public UserAttribute.Builder clearLastPurchaseDateTime()
         Timestamp of the last purchase made by the user.
 The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
 optional timezone offset from UTC. If the offset is absent, the API will
 use the account's timezone as default.
        string last_purchase_date_time = 3;
        Returns:
        This builder for chaining.

      • setLastPurchaseDateTimeBytes

        public UserAttribute.Builder setLastPurchaseDateTimeBytes​(com.google.protobuf.ByteString value)
         Timestamp of the last purchase made by the user.
 The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
 optional timezone offset from UTC. If the offset is absent, the API will
 use the account's timezone as default.
        string last_purchase_date_time = 3;
        Parameters:
        value - The bytes for lastPurchaseDateTime to set.
        Returns:
        This builder for chaining.

      • getAveragePurchaseCount

        public int getAveragePurchaseCount()
         Advertiser defined average number of purchases that are made by the user in
 a 30 day period.
        int32 average_purchase_count = 4;
        Specified by:
        getAveragePurchaseCount in interface UserAttributeOrBuilder
        Returns:
        The averagePurchaseCount.

      • setAveragePurchaseCount

        public UserAttribute.Builder setAveragePurchaseCount​(int value)
         Advertiser defined average number of purchases that are made by the user in
 a 30 day period.
        int32 average_purchase_count = 4;
        Parameters:
        value - The averagePurchaseCount to set.
        Returns:
        This builder for chaining.

      • clearAveragePurchaseCount

        public UserAttribute.Builder clearAveragePurchaseCount()
         Advertiser defined average number of purchases that are made by the user in
 a 30 day period.
        int32 average_purchase_count = 4;
        Returns:
        This builder for chaining.

      • getAveragePurchaseValueMicros

        public long getAveragePurchaseValueMicros()
         Advertiser defined average purchase value in micros for the user.
        int64 average_purchase_value_micros = 5;
        Specified by:
        getAveragePurchaseValueMicros in interface UserAttributeOrBuilder
        Returns:
        The averagePurchaseValueMicros.

      • setAveragePurchaseValueMicros

        public UserAttribute.Builder setAveragePurchaseValueMicros​(long value)
         Advertiser defined average purchase value in micros for the user.
        int64 average_purchase_value_micros = 5;
        Parameters:
        value - The averagePurchaseValueMicros to set.
        Returns:
        This builder for chaining.

      • clearAveragePurchaseValueMicros

        public UserAttribute.Builder clearAveragePurchaseValueMicros()
         Advertiser defined average purchase value in micros for the user.
        int64 average_purchase_value_micros = 5;
        Returns:
        This builder for chaining.

      • getAcquisitionDateTime

        public java.lang.String getAcquisitionDateTime()
         Timestamp when the user was acquired.
 The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
 optional timezone offset from UTC. If the offset is absent, the API will
 use the account's timezone as default.
        string acquisition_date_time = 6;
        Specified by:
        getAcquisitionDateTime in interface UserAttributeOrBuilder
        Returns:
        The acquisitionDateTime.

      • getAcquisitionDateTimeBytes

        public com.google.protobuf.ByteString getAcquisitionDateTimeBytes()
         Timestamp when the user was acquired.
 The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
 optional timezone offset from UTC. If the offset is absent, the API will
 use the account's timezone as default.
        string acquisition_date_time = 6;
        Specified by:
        getAcquisitionDateTimeBytes in interface UserAttributeOrBuilder
        Returns:
        The bytes for acquisitionDateTime.

      • setAcquisitionDateTime

        public UserAttribute.Builder setAcquisitionDateTime​(java.lang.String value)
         Timestamp when the user was acquired.
 The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
 optional timezone offset from UTC. If the offset is absent, the API will
 use the account's timezone as default.
        string acquisition_date_time = 6;
        Parameters:
        value - The acquisitionDateTime to set.
        Returns:
        This builder for chaining.

      • clearAcquisitionDateTime

        public UserAttribute.Builder clearAcquisitionDateTime()
         Timestamp when the user was acquired.
 The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
 optional timezone offset from UTC. If the offset is absent, the API will
 use the account's timezone as default.
        string acquisition_date_time = 6;
        Returns:
        This builder for chaining.

      • setAcquisitionDateTimeBytes

        public UserAttribute.Builder setAcquisitionDateTimeBytes​(com.google.protobuf.ByteString value)
         Timestamp when the user was acquired.
 The format is YYYY-MM-DD HH:MM:SS[+/-HH:MM], where [+/-HH:MM] is an
 optional timezone offset from UTC. If the offset is absent, the API will
 use the account's timezone as default.
        string acquisition_date_time = 6;
        Parameters:
        value - The bytes for acquisitionDateTime to set.
        Returns:
        This builder for chaining.

      • hasShoppingLoyalty

        public boolean hasShoppingLoyalty()
         The shopping loyalty related data. Shopping utilizes this data to provide
 users with a better experience. Accessible only to merchants on the
 allow-list with the user's consent.
        optional .google.ads.googleads.v10.common.ShoppingLoyalty shopping_loyalty = 7;
        Specified by:
        hasShoppingLoyalty in interface UserAttributeOrBuilder
        Returns:
        Whether the shoppingLoyalty field is set.

      • getShoppingLoyalty

        public ShoppingLoyalty getShoppingLoyalty()
         The shopping loyalty related data. Shopping utilizes this data to provide
 users with a better experience. Accessible only to merchants on the
 allow-list with the user's consent.
        optional .google.ads.googleads.v10.common.ShoppingLoyalty shopping_loyalty = 7;
        Specified by:
        getShoppingLoyalty in interface UserAttributeOrBuilder
        Returns:
        The shoppingLoyalty.

      • setShoppingLoyalty

        public UserAttribute.Builder setShoppingLoyalty​(ShoppingLoyalty value)
         The shopping loyalty related data. Shopping utilizes this data to provide
 users with a better experience. Accessible only to merchants on the
 allow-list with the user's consent.
        optional .google.ads.googleads.v10.common.ShoppingLoyalty shopping_loyalty = 7;

      • setShoppingLoyalty

        public UserAttribute.Builder setShoppingLoyalty​(ShoppingLoyalty.Builder builderForValue)
         The shopping loyalty related data. Shopping utilizes this data to provide
 users with a better experience. Accessible only to merchants on the
 allow-list with the user's consent.
        optional .google.ads.googleads.v10.common.ShoppingLoyalty shopping_loyalty = 7;

      • mergeShoppingLoyalty

        public UserAttribute.Builder mergeShoppingLoyalty​(ShoppingLoyalty value)
         The shopping loyalty related data. Shopping utilizes this data to provide
 users with a better experience. Accessible only to merchants on the
 allow-list with the user's consent.
        optional .google.ads.googleads.v10.common.ShoppingLoyalty shopping_loyalty = 7;

      • clearShoppingLoyalty

        public UserAttribute.Builder clearShoppingLoyalty()
         The shopping loyalty related data. Shopping utilizes this data to provide
 users with a better experience. Accessible only to merchants on the
 allow-list with the user's consent.
        optional .google.ads.googleads.v10.common.ShoppingLoyalty shopping_loyalty = 7;

      • getShoppingLoyaltyBuilder

        public ShoppingLoyalty.Builder getShoppingLoyaltyBuilder()
         The shopping loyalty related data. Shopping utilizes this data to provide
 users with a better experience. Accessible only to merchants on the
 allow-list with the user's consent.
        optional .google.ads.googleads.v10.common.ShoppingLoyalty shopping_loyalty = 7;

      • getShoppingLoyaltyOrBuilder

        public ShoppingLoyaltyOrBuilder getShoppingLoyaltyOrBuilder()
         The shopping loyalty related data. Shopping utilizes this data to provide
 users with a better experience. Accessible only to merchants on the
 allow-list with the user's consent.
        optional .google.ads.googleads.v10.common.ShoppingLoyalty shopping_loyalty = 7;
        Specified by:
        getShoppingLoyaltyOrBuilder in interface UserAttributeOrBuilder

      • setUnknownFields

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

      • mergeUnknownFields

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