Package com.google.ads.googleads.v14.common

Class UserIdentifier

  • All Implemented Interfaces:
    UserIdentifierOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class UserIdentifier
extends com.google.protobuf.GeneratedMessageV3
implements UserIdentifierOrBuilder
     User identifying information.
    Protobuf type google.ads.googleads.v14.common.UserIdentifier
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UserIdentifier.Builder
      User identifying information.
      static class  UserIdentifier.IdentifierCase  

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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      OfflineUserAddressInfo getAddressInfo()
      Address information.
      OfflineUserAddressInfoOrBuilder getAddressInfoOrBuilder()
      Address information.
      static UserIdentifier getDefaultInstance()  
      UserIdentifier getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getHashedEmail()
      Hashed email address using SHA-256 hash function after normalization.
      com.google.protobuf.ByteString getHashedEmailBytes()
      Hashed email address using SHA-256 hash function after normalization.
      java.lang.String getHashedPhoneNumber()
      Hashed phone number using SHA-256 hash function after normalization (E164 standard).
      com.google.protobuf.ByteString getHashedPhoneNumberBytes()
      Hashed phone number using SHA-256 hash function after normalization (E164 standard).
      UserIdentifier.IdentifierCase getIdentifierCase()  
      java.lang.String getMobileId()
      Mobile device ID (advertising ID/IDFA).
      com.google.protobuf.ByteString getMobileIdBytes()
      Mobile device ID (advertising ID/IDFA).
      com.google.protobuf.Parser<UserIdentifier> getParserForType()  
      int getSerializedSize()  
      java.lang.String getThirdPartyUserId()
      Advertiser-assigned user ID for Customer Match upload, or third-party-assigned user ID for Store Sales.
      com.google.protobuf.ByteString getThirdPartyUserIdBytes()
      Advertiser-assigned user ID for Customer Match upload, or third-party-assigned user ID for Store Sales.
      UserIdentifierSourceEnum.UserIdentifierSource getUserIdentifierSource()
      Source of the user identifier when the upload is from Store Sales, ConversionUploadService, or ConversionAdjustmentUploadService.
      int getUserIdentifierSourceValue()
      Source of the user identifier when the upload is from Store Sales, ConversionUploadService, or ConversionAdjustmentUploadService.
      boolean hasAddressInfo()
      Address information.
      boolean hasHashedEmail()
      Hashed email address using SHA-256 hash function after normalization.
      boolean hasHashedPhoneNumber()
      Hashed phone number using SHA-256 hash function after normalization (E164 standard).
      int hashCode()  
      boolean hasMobileId()
      Mobile device ID (advertising ID/IDFA).
      boolean hasThirdPartyUserId()
      Advertiser-assigned user ID for Customer Match upload, or third-party-assigned user ID for Store Sales.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static UserIdentifier.Builder newBuilder()  
      static UserIdentifier.Builder newBuilder​(UserIdentifier prototype)  
      UserIdentifier.Builder newBuilderForType()  
      protected UserIdentifier.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static UserIdentifier parseDelimitedFrom​(java.io.InputStream input)  
      static UserIdentifier parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UserIdentifier parseFrom​(byte[] data)  
      static UserIdentifier parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UserIdentifier parseFrom​(com.google.protobuf.ByteString data)  
      static UserIdentifier parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UserIdentifier parseFrom​(com.google.protobuf.CodedInputStream input)  
      static UserIdentifier parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UserIdentifier parseFrom​(java.io.InputStream input)  
      static UserIdentifier parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UserIdentifier parseFrom​(java.nio.ByteBuffer data)  
      static UserIdentifier parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<UserIdentifier> parser()  
      UserIdentifier.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Field Detail

      • USER_IDENTIFIER_SOURCE_FIELD_NUMBER

        public static final int USER_IDENTIFIER_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HASHED_EMAIL_FIELD_NUMBER

        public static final int HASHED_EMAIL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HASHED_PHONE_NUMBER_FIELD_NUMBER

        public static final int HASHED_PHONE_NUMBER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • THIRD_PARTY_USER_ID_FIELD_NUMBER

        public static final int THIRD_PARTY_USER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADDRESS_INFO_FIELD_NUMBER

        public static final int ADDRESS_INFO_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

      • 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

      • getUserIdentifierSourceValue

        public int getUserIdentifierSourceValue()
         Source of the user identifier when the upload is from Store Sales,
 ConversionUploadService, or ConversionAdjustmentUploadService.
        .google.ads.googleads.v14.enums.UserIdentifierSourceEnum.UserIdentifierSource user_identifier_source = 6;
        Specified by:
        getUserIdentifierSourceValue in interface UserIdentifierOrBuilder
        Returns:
        The enum numeric value on the wire for userIdentifierSource.

      • hasHashedEmail

        public boolean hasHashedEmail()
         Hashed email address using SHA-256 hash function after normalization.
 Accepted for Customer Match, Store Sales, ConversionUploadService, and
 ConversionAdjustmentUploadService.
        string hashed_email = 7;
        Specified by:
        hasHashedEmail in interface UserIdentifierOrBuilder
        Returns:
        Whether the hashedEmail field is set.

      • getHashedEmail

        public java.lang.String getHashedEmail()
         Hashed email address using SHA-256 hash function after normalization.
 Accepted for Customer Match, Store Sales, ConversionUploadService, and
 ConversionAdjustmentUploadService.
        string hashed_email = 7;
        Specified by:
        getHashedEmail in interface UserIdentifierOrBuilder
        Returns:
        The hashedEmail.

      • getHashedEmailBytes

        public com.google.protobuf.ByteString getHashedEmailBytes()
         Hashed email address using SHA-256 hash function after normalization.
 Accepted for Customer Match, Store Sales, ConversionUploadService, and
 ConversionAdjustmentUploadService.
        string hashed_email = 7;
        Specified by:
        getHashedEmailBytes in interface UserIdentifierOrBuilder
        Returns:
        The bytes for hashedEmail.

      • hasHashedPhoneNumber

        public boolean hasHashedPhoneNumber()
         Hashed phone number using SHA-256 hash function after normalization
 (E164 standard). Accepted for Customer Match, Store Sales,
 ConversionUploadService, and ConversionAdjustmentUploadService.
        string hashed_phone_number = 8;
        Specified by:
        hasHashedPhoneNumber in interface UserIdentifierOrBuilder
        Returns:
        Whether the hashedPhoneNumber field is set.

      • getHashedPhoneNumber

        public java.lang.String getHashedPhoneNumber()
         Hashed phone number using SHA-256 hash function after normalization
 (E164 standard). Accepted for Customer Match, Store Sales,
 ConversionUploadService, and ConversionAdjustmentUploadService.
        string hashed_phone_number = 8;
        Specified by:
        getHashedPhoneNumber in interface UserIdentifierOrBuilder
        Returns:
        The hashedPhoneNumber.

      • getHashedPhoneNumberBytes

        public com.google.protobuf.ByteString getHashedPhoneNumberBytes()
         Hashed phone number using SHA-256 hash function after normalization
 (E164 standard). Accepted for Customer Match, Store Sales,
 ConversionUploadService, and ConversionAdjustmentUploadService.
        string hashed_phone_number = 8;
        Specified by:
        getHashedPhoneNumberBytes in interface UserIdentifierOrBuilder
        Returns:
        The bytes for hashedPhoneNumber.

      • hasMobileId

        public boolean hasMobileId()
         Mobile device ID (advertising ID/IDFA). Accepted only for Customer Match.
        string mobile_id = 9;
        Specified by:
        hasMobileId in interface UserIdentifierOrBuilder
        Returns:
        Whether the mobileId field is set.

      • getMobileId

        public java.lang.String getMobileId()
         Mobile device ID (advertising ID/IDFA). Accepted only for Customer Match.
        string mobile_id = 9;
        Specified by:
        getMobileId in interface UserIdentifierOrBuilder
        Returns:
        The mobileId.

      • getMobileIdBytes

        public com.google.protobuf.ByteString getMobileIdBytes()
         Mobile device ID (advertising ID/IDFA). Accepted only for Customer Match.
        string mobile_id = 9;
        Specified by:
        getMobileIdBytes in interface UserIdentifierOrBuilder
        Returns:
        The bytes for mobileId.

      • hasThirdPartyUserId

        public boolean hasThirdPartyUserId()
         Advertiser-assigned user ID for Customer Match upload, or
 third-party-assigned user ID for Store Sales. Accepted only for Customer
 Match and Store Sales.
        string third_party_user_id = 10;
        Specified by:
        hasThirdPartyUserId in interface UserIdentifierOrBuilder
        Returns:
        Whether the thirdPartyUserId field is set.

      • getThirdPartyUserId

        public java.lang.String getThirdPartyUserId()
         Advertiser-assigned user ID for Customer Match upload, or
 third-party-assigned user ID for Store Sales. Accepted only for Customer
 Match and Store Sales.
        string third_party_user_id = 10;
        Specified by:
        getThirdPartyUserId in interface UserIdentifierOrBuilder
        Returns:
        The thirdPartyUserId.

      • getThirdPartyUserIdBytes

        public com.google.protobuf.ByteString getThirdPartyUserIdBytes()
         Advertiser-assigned user ID for Customer Match upload, or
 third-party-assigned user ID for Store Sales. Accepted only for Customer
 Match and Store Sales.
        string third_party_user_id = 10;
        Specified by:
        getThirdPartyUserIdBytes in interface UserIdentifierOrBuilder
        Returns:
        The bytes for thirdPartyUserId.

      • hasAddressInfo

        public boolean hasAddressInfo()
         Address information. Accepted only for Customer Match, Store Sales, and
 ConversionAdjustmentUploadService.
        .google.ads.googleads.v14.common.OfflineUserAddressInfo address_info = 5;
        Specified by:
        hasAddressInfo in interface UserIdentifierOrBuilder
        Returns:
        Whether the addressInfo field is set.

      • getAddressInfo

        public OfflineUserAddressInfo getAddressInfo()
         Address information. Accepted only for Customer Match, Store Sales, and
 ConversionAdjustmentUploadService.
        .google.ads.googleads.v14.common.OfflineUserAddressInfo address_info = 5;
        Specified by:
        getAddressInfo in interface UserIdentifierOrBuilder
        Returns:
        The addressInfo.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static UserIdentifier getDefaultInstance()

      • parser

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

      • getParserForType

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