Package com.google.ads.googleads.v18.services

Class ClickConversion

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.services.ClickConversion
All Implemented Interfaces:
ClickConversionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ClickConversion extends com.google.protobuf.GeneratedMessageV3 implements ClickConversionOrBuilder
 A click conversion.
Protobuf type google.ads.googleads.v18.services.ClickConversion
See Also:

  • Field Details

    • GCLID_FIELD_NUMBER

      public static final int GCLID_FIELD_NUMBER
      See Also:

    • GBRAID_FIELD_NUMBER

      public static final int GBRAID_FIELD_NUMBER
      See Also:

    • WBRAID_FIELD_NUMBER

      public static final int WBRAID_FIELD_NUMBER
      See Also:

    • CONVERSION_ACTION_FIELD_NUMBER

      public static final int CONVERSION_ACTION_FIELD_NUMBER
      See Also:

    • CONVERSION_DATE_TIME_FIELD_NUMBER

      public static final int CONVERSION_DATE_TIME_FIELD_NUMBER
      See Also:

    • CONVERSION_VALUE_FIELD_NUMBER

      public static final int CONVERSION_VALUE_FIELD_NUMBER
      See Also:

    • CURRENCY_CODE_FIELD_NUMBER

      public static final int CURRENCY_CODE_FIELD_NUMBER
      See Also:

    • ORDER_ID_FIELD_NUMBER

      public static final int ORDER_ID_FIELD_NUMBER
      See Also:

    • EXTERNAL_ATTRIBUTION_DATA_FIELD_NUMBER

      public static final int EXTERNAL_ATTRIBUTION_DATA_FIELD_NUMBER
      See Also:

    • CUSTOM_VARIABLES_FIELD_NUMBER

      public static final int CUSTOM_VARIABLES_FIELD_NUMBER
      See Also:

    • CART_DATA_FIELD_NUMBER

      public static final int CART_DATA_FIELD_NUMBER
      See Also:

    • USER_IDENTIFIERS_FIELD_NUMBER

      public static final int USER_IDENTIFIERS_FIELD_NUMBER
      See Also:

    • CONVERSION_ENVIRONMENT_FIELD_NUMBER

      public static final int CONVERSION_ENVIRONMENT_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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

    • 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 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 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 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 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", for example, "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 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", for example, "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", for example, "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 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 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.v18.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.v18.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.v18.services.ExternalAttributionData external_attribution_data = 7;
      Specified by:
      getExternalAttributionDataOrBuilder in interface ClickConversionOrBuilder

    • getCustomVariablesList

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

    • getCustomVariablesOrBuilderList

      public List<? extends CustomVariableOrBuilder> getCustomVariablesOrBuilderList()
       The custom variables associated with this conversion.
      repeated .google.ads.googleads.v18.services.CustomVariable custom_variables = 15;
      Specified by:
      getCustomVariablesOrBuilderList in interface ClickConversionOrBuilder

    • getCustomVariablesCount

      public int getCustomVariablesCount()
       The custom variables associated with this conversion.
      repeated .google.ads.googleads.v18.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.v18.services.CustomVariable custom_variables = 15;
      Specified by:
      getCustomVariables in interface ClickConversionOrBuilder

    • getCustomVariablesOrBuilder

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

    • hasCartData

      public boolean hasCartData()
       The cart data associated with this conversion.
      .google.ads.googleads.v18.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.v18.services.CartData cart_data = 16;
      Specified by:
      getCartData in interface ClickConversionOrBuilder
      Returns:
      The cartData.

    • getCartDataOrBuilder

      public CartDataOrBuilder getCartDataOrBuilder()
       The cart data associated with this conversion.
      .google.ads.googleads.v18.services.CartData cart_data = 16;
      Specified by:
      getCartDataOrBuilder in interface ClickConversionOrBuilder

    • getUserIdentifiersList

      public 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.v18.common.UserIdentifier user_identifiers = 17;
      Specified by:
      getUserIdentifiersList in interface ClickConversionOrBuilder

    • getUserIdentifiersOrBuilderList

      public 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.v18.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.v18.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.v18.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.v18.common.UserIdentifier user_identifiers = 17;
      Specified by:
      getUserIdentifiersOrBuilder in interface ClickConversionOrBuilder

    • getConversionEnvironmentValue

      public int getConversionEnvironmentValue()
       The environment this conversion was recorded on, for example, App or Web.
      .google.ads.googleads.v18.enums.ConversionEnvironmentEnum.ConversionEnvironment conversion_environment = 20;
      Specified by:
      getConversionEnvironmentValue in interface ClickConversionOrBuilder
      Returns:
      The enum numeric value on the wire for conversionEnvironment.

    • getConversionEnvironment

      public ConversionEnvironmentEnum.ConversionEnvironment getConversionEnvironment()
       The environment this conversion was recorded on, for example, App or Web.
      .google.ads.googleads.v18.enums.ConversionEnvironmentEnum.ConversionEnvironment conversion_environment = 20;
      Specified by:
      getConversionEnvironment in interface ClickConversionOrBuilder
      Returns:
      The conversionEnvironment.

    • hasConsent

      public boolean hasConsent()
       The consent setting for the event.
      .google.ads.googleads.v18.common.Consent consent = 23;
      Specified by:
      hasConsent in interface ClickConversionOrBuilder
      Returns:
      Whether the consent field is set.

    • getConsent

      public Consent getConsent()
       The consent setting for the event.
      .google.ads.googleads.v18.common.Consent consent = 23;
      Specified by:
      getConsent in interface ClickConversionOrBuilder
      Returns:
      The consent.

    • getConsentOrBuilder

      public ConsentOrBuilder getConsentOrBuilder()
       The consent setting for the event.
      .google.ads.googleads.v18.common.Consent consent = 23;
      Specified by:
      getConsentOrBuilder 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClickConversion parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ClickConversion parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ClickConversion.Builder newBuilder()

    • newBuilder

      public static ClickConversion.Builder newBuilder(ClickConversion prototype)

    • 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

    • getDefaultInstance

      public static ClickConversion getDefaultInstance()

    • 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