Package com.google.ads.googleads.v10.services

Class ClickConversion

  • All Implemented Interfaces:
    ClickConversionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class ClickConversion
extends com.google.protobuf.GeneratedMessageV3
implements ClickConversionOrBuilder
     A click conversion.
    Protobuf type google.ads.googleads.v10.services.ClickConversion
    See Also:
    Serialized Form

    • Field Detail

      • CONVERSION_ACTION_FIELD_NUMBER

        public static final int CONVERSION_ACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONVERSION_DATE_TIME_FIELD_NUMBER

        public static final int CONVERSION_DATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONVERSION_VALUE_FIELD_NUMBER

        public static final int CONVERSION_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENCY_CODE_FIELD_NUMBER

        public static final int CURRENCY_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXTERNAL_ATTRIBUTION_DATA_FIELD_NUMBER

        public static final int EXTERNAL_ATTRIBUTION_DATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOM_VARIABLES_FIELD_NUMBER

        public static final int CUSTOM_VARIABLES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USER_IDENTIFIERS_FIELD_NUMBER

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

      • hasGclid

        public boolean hasGclid()
         The Google click ID (gclid) associated with this conversion.
        optional string gclid = 9;
        Specified by:
        hasGclid in interface ClickConversionOrBuilder
        Returns:
        Whether the gclid field is set.

      • getGclid

        public java.lang.String getGclid()
         The Google click ID (gclid) associated with this conversion.
        optional string gclid = 9;
        Specified by:
        getGclid in interface ClickConversionOrBuilder
        Returns:
        The gclid.

      • getGclidBytes

        public com.google.protobuf.ByteString getGclidBytes()
         The Google click ID (gclid) associated with this conversion.
        optional string gclid = 9;
        Specified by:
        getGclidBytes in interface ClickConversionOrBuilder
        Returns:
        The bytes for gclid.

      • getGbraid

        public java.lang.String getGbraid()
         The click identifier for clicks associated with app conversions and
 originating from iOS devices starting with iOS14.
        string gbraid = 18;
        Specified by:
        getGbraid in interface ClickConversionOrBuilder
        Returns:
        The gbraid.

      • getGbraidBytes

        public com.google.protobuf.ByteString getGbraidBytes()
         The click identifier for clicks associated with app conversions and
 originating from iOS devices starting with iOS14.
        string gbraid = 18;
        Specified by:
        getGbraidBytes in interface ClickConversionOrBuilder
        Returns:
        The bytes for gbraid.

      • getWbraid

        public java.lang.String getWbraid()
         The click identifier for clicks associated with web conversions and
 originating from iOS devices starting with iOS14.
        string wbraid = 19;
        Specified by:
        getWbraid in interface ClickConversionOrBuilder
        Returns:
        The wbraid.

      • getWbraidBytes

        public com.google.protobuf.ByteString getWbraidBytes()
         The click identifier for clicks associated with web conversions and
 originating from iOS devices starting with iOS14.
        string wbraid = 19;
        Specified by:
        getWbraidBytes in interface ClickConversionOrBuilder
        Returns:
        The bytes for wbraid.

      • hasConversionAction

        public boolean hasConversionAction()
         Resource name of the conversion action associated with this conversion.
 Note: Although this resource name consists of a customer id and a
 conversion action id, validation will ignore the customer id and use the
 conversion action id as the sole identifier of the conversion action.
        optional string conversion_action = 10;
        Specified by:
        hasConversionAction in interface ClickConversionOrBuilder
        Returns:
        Whether the conversionAction field is set.

      • getConversionAction

        public java.lang.String getConversionAction()
         Resource name of the conversion action associated with this conversion.
 Note: Although this resource name consists of a customer id and a
 conversion action id, validation will ignore the customer id and use the
 conversion action id as the sole identifier of the conversion action.
        optional string conversion_action = 10;
        Specified by:
        getConversionAction in interface ClickConversionOrBuilder
        Returns:
        The conversionAction.

      • getConversionActionBytes

        public com.google.protobuf.ByteString getConversionActionBytes()
         Resource name of the conversion action associated with this conversion.
 Note: Although this resource name consists of a customer id and a
 conversion action id, validation will ignore the customer id and use the
 conversion action id as the sole identifier of the conversion action.
        optional string conversion_action = 10;
        Specified by:
        getConversionActionBytes in interface ClickConversionOrBuilder
        Returns:
        The bytes for conversionAction.

      • hasConversionDateTime

        public boolean hasConversionDateTime()
         The date time at which the conversion occurred. Must be after
 the click time. The timezone must be specified. The format is
 "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
        optional string conversion_date_time = 11;
        Specified by:
        hasConversionDateTime in interface ClickConversionOrBuilder
        Returns:
        Whether the conversionDateTime field is set.

      • getConversionDateTime

        public java.lang.String getConversionDateTime()
         The date time at which the conversion occurred. Must be after
 the click time. The timezone must be specified. The format is
 "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
        optional string conversion_date_time = 11;
        Specified by:
        getConversionDateTime in interface ClickConversionOrBuilder
        Returns:
        The conversionDateTime.

      • getConversionDateTimeBytes

        public com.google.protobuf.ByteString getConversionDateTimeBytes()
         The date time at which the conversion occurred. Must be after
 the click time. The timezone must be specified. The format is
 "yyyy-mm-dd hh:mm:ss+|-hh:mm", e.g. "2019-01-01 12:32:45-08:00".
        optional string conversion_date_time = 11;
        Specified by:
        getConversionDateTimeBytes in interface ClickConversionOrBuilder
        Returns:
        The bytes for conversionDateTime.

      • hasConversionValue

        public boolean hasConversionValue()
         The value of the conversion for the advertiser.
        optional double conversion_value = 12;
        Specified by:
        hasConversionValue in interface ClickConversionOrBuilder
        Returns:
        Whether the conversionValue field is set.

      • getConversionValue

        public double getConversionValue()
         The value of the conversion for the advertiser.
        optional double conversion_value = 12;
        Specified by:
        getConversionValue in interface ClickConversionOrBuilder
        Returns:
        The conversionValue.

      • hasCurrencyCode

        public boolean hasCurrencyCode()
         Currency associated with the conversion value. This is the ISO 4217
 3-character currency code. For example: USD, EUR.
        optional string currency_code = 13;
        Specified by:
        hasCurrencyCode in interface ClickConversionOrBuilder
        Returns:
        Whether the currencyCode field is set.

      • getCurrencyCode

        public java.lang.String getCurrencyCode()
         Currency associated with the conversion value. This is the ISO 4217
 3-character currency code. For example: USD, EUR.
        optional string currency_code = 13;
        Specified by:
        getCurrencyCode in interface ClickConversionOrBuilder
        Returns:
        The currencyCode.

      • getCurrencyCodeBytes

        public com.google.protobuf.ByteString getCurrencyCodeBytes()
         Currency associated with the conversion value. This is the ISO 4217
 3-character currency code. For example: USD, EUR.
        optional string currency_code = 13;
        Specified by:
        getCurrencyCodeBytes in interface ClickConversionOrBuilder
        Returns:
        The bytes for currencyCode.

      • hasOrderId

        public boolean hasOrderId()
         The order ID associated with the conversion. An order id can only be used
 for one conversion per conversion action.
        optional string order_id = 14;
        Specified by:
        hasOrderId in interface ClickConversionOrBuilder
        Returns:
        Whether the orderId field is set.

      • getOrderId

        public java.lang.String getOrderId()
         The order ID associated with the conversion. An order id can only be used
 for one conversion per conversion action.
        optional string order_id = 14;
        Specified by:
        getOrderId in interface ClickConversionOrBuilder
        Returns:
        The orderId.

      • getOrderIdBytes

        public com.google.protobuf.ByteString getOrderIdBytes()
         The order ID associated with the conversion. An order id can only be used
 for one conversion per conversion action.
        optional string order_id = 14;
        Specified by:
        getOrderIdBytes in interface ClickConversionOrBuilder
        Returns:
        The bytes for orderId.

      • hasExternalAttributionData

        public boolean hasExternalAttributionData()
         Additional data about externally attributed conversions. This field
 is required for conversions with an externally attributed conversion
 action, but should not be set otherwise.
        .google.ads.googleads.v10.services.ExternalAttributionData external_attribution_data = 7;
        Specified by:
        hasExternalAttributionData in interface ClickConversionOrBuilder
        Returns:
        Whether the externalAttributionData field is set.

      • getExternalAttributionData

        public ExternalAttributionData getExternalAttributionData()
         Additional data about externally attributed conversions. This field
 is required for conversions with an externally attributed conversion
 action, but should not be set otherwise.
        .google.ads.googleads.v10.services.ExternalAttributionData external_attribution_data = 7;
        Specified by:
        getExternalAttributionData in interface ClickConversionOrBuilder
        Returns:
        The externalAttributionData.

      • getExternalAttributionDataOrBuilder

        public ExternalAttributionDataOrBuilder getExternalAttributionDataOrBuilder()
         Additional data about externally attributed conversions. This field
 is required for conversions with an externally attributed conversion
 action, but should not be set otherwise.
        .google.ads.googleads.v10.services.ExternalAttributionData external_attribution_data = 7;
        Specified by:
        getExternalAttributionDataOrBuilder in interface ClickConversionOrBuilder

      • getCustomVariablesList

        public java.util.List<CustomVariable> getCustomVariablesList()
         The custom variables associated with this conversion.
        repeated .google.ads.googleads.v10.services.CustomVariable custom_variables = 15;
        Specified by:
        getCustomVariablesList in interface ClickConversionOrBuilder

      • getCustomVariablesCount

        public int getCustomVariablesCount()
         The custom variables associated with this conversion.
        repeated .google.ads.googleads.v10.services.CustomVariable custom_variables = 15;
        Specified by:
        getCustomVariablesCount in interface ClickConversionOrBuilder

      • getCustomVariables

        public CustomVariable getCustomVariables​(int index)
         The custom variables associated with this conversion.
        repeated .google.ads.googleads.v10.services.CustomVariable custom_variables = 15;
        Specified by:
        getCustomVariables in interface ClickConversionOrBuilder

      • hasCartData

        public boolean hasCartData()
         The cart data associated with this conversion.
        .google.ads.googleads.v10.services.CartData cart_data = 16;
        Specified by:
        hasCartData in interface ClickConversionOrBuilder
        Returns:
        Whether the cartData field is set.

      • getCartData

        public CartData getCartData()
         The cart data associated with this conversion.
        .google.ads.googleads.v10.services.CartData cart_data = 16;
        Specified by:
        getCartData in interface ClickConversionOrBuilder
        Returns:
        The cartData.

      • getUserIdentifiersList

        public java.util.List<UserIdentifier> getUserIdentifiersList()
         The user identifiers associated with this conversion. Only hashed_email and
 hashed_phone_number are supported for conversion uploads. The maximum
 number of user identifiers for each conversion is 5.
        repeated .google.ads.googleads.v10.common.UserIdentifier user_identifiers = 17;
        Specified by:
        getUserIdentifiersList in interface ClickConversionOrBuilder

      • getUserIdentifiersOrBuilderList

        public java.util.List<? extends UserIdentifierOrBuilder> getUserIdentifiersOrBuilderList()
         The user identifiers associated with this conversion. Only hashed_email and
 hashed_phone_number are supported for conversion uploads. The maximum
 number of user identifiers for each conversion is 5.
        repeated .google.ads.googleads.v10.common.UserIdentifier user_identifiers = 17;
        Specified by:
        getUserIdentifiersOrBuilderList in interface ClickConversionOrBuilder

      • getUserIdentifiersCount

        public int getUserIdentifiersCount()
         The user identifiers associated with this conversion. Only hashed_email and
 hashed_phone_number are supported for conversion uploads. The maximum
 number of user identifiers for each conversion is 5.
        repeated .google.ads.googleads.v10.common.UserIdentifier user_identifiers = 17;
        Specified by:
        getUserIdentifiersCount in interface ClickConversionOrBuilder

      • getUserIdentifiers

        public UserIdentifier getUserIdentifiers​(int index)
         The user identifiers associated with this conversion. Only hashed_email and
 hashed_phone_number are supported for conversion uploads. The maximum
 number of user identifiers for each conversion is 5.
        repeated .google.ads.googleads.v10.common.UserIdentifier user_identifiers = 17;
        Specified by:
        getUserIdentifiers in interface ClickConversionOrBuilder

      • getUserIdentifiersOrBuilder

        public UserIdentifierOrBuilder getUserIdentifiersOrBuilder​(int index)
         The user identifiers associated with this conversion. Only hashed_email and
 hashed_phone_number are supported for conversion uploads. The maximum
 number of user identifiers for each conversion is 5.
        repeated .google.ads.googleads.v10.common.UserIdentifier user_identifiers = 17;
        Specified by:
        getUserIdentifiersOrBuilder in interface ClickConversionOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

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

      • getParserForType

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