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

Class UserAttribute

  • All Implemented Interfaces:
    UserAttributeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class UserAttribute
extends com.google.protobuf.GeneratedMessageV3
implements UserAttributeOrBuilder
     User attribute, can only be used with CUSTOMER_MATCH_WITH_ATTRIBUTES job
 type.
    Protobuf type google.ads.googleads.v10.common.UserAttribute
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UserAttribute.Builder
      User attribute, can only be used with CUSTOMER_MATCH_WITH_ATTRIBUTES job type.

      • 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

    • Field Detail

      • LIFETIME_VALUE_MICROS_FIELD_NUMBER

        public static final int LIFETIME_VALUE_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LIFETIME_VALUE_BUCKET_FIELD_NUMBER

        public static final int LIFETIME_VALUE_BUCKET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LAST_PURCHASE_DATE_TIME_FIELD_NUMBER

        public static final int LAST_PURCHASE_DATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AVERAGE_PURCHASE_COUNT_FIELD_NUMBER

        public static final int AVERAGE_PURCHASE_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AVERAGE_PURCHASE_VALUE_MICROS_FIELD_NUMBER

        public static final int AVERAGE_PURCHASE_VALUE_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACQUISITION_DATE_TIME_FIELD_NUMBER

        public static final int ACQUISITION_DATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SHOPPING_LOYALTY_FIELD_NUMBER

        public static final int SHOPPING_LOYALTY_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

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

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

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

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

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

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

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

      • 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

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static UserAttribute getDefaultInstance()

      • parser

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

      • getParserForType

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