Package com.google.ads.googleads.v21.services

Interface ClickConversionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ClickConversion, ClickConversion.Builder
public interface ClickConversionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasGclid

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

    • getGclid

      String getGclid()
       The Google click ID (gclid) associated with this conversion.
      optional string gclid = 9;
      Returns:
      The gclid.

    • getGclidBytes

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

    • getGbraid

      String getGbraid()
       The click identifier for clicks associated with app conversions and
 originating from iOS devices starting with iOS14.
      string gbraid = 18;
      Returns:
      The gbraid.

    • getGbraidBytes

      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;
      Returns:
      The bytes for gbraid.

    • getWbraid

      String getWbraid()
       The click identifier for clicks associated with web conversions and
 originating from iOS devices starting with iOS14.
      string wbraid = 19;
      Returns:
      The wbraid.

    • getWbraidBytes

      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;
      Returns:
      The bytes for wbraid.

    • hasConversionAction

      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;
      Returns:
      Whether the conversionAction field is set.

    • getConversionAction

      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;
      Returns:
      The conversionAction.

    • getConversionActionBytes

      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;
      Returns:
      The bytes for conversionAction.

    • hasConversionDateTime

      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;
      Returns:
      Whether the conversionDateTime field is set.

    • getConversionDateTime

      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;
      Returns:
      The conversionDateTime.

    • getConversionDateTimeBytes

      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;
      Returns:
      The bytes for conversionDateTime.

    • hasConversionValue

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

    • getConversionValue

      double getConversionValue()
       The value of the conversion for the advertiser.
      optional double conversion_value = 12;
      Returns:
      The conversionValue.

    • hasCurrencyCode

      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;
      Returns:
      Whether the currencyCode field is set.

    • getCurrencyCode

      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;
      Returns:
      The currencyCode.

    • getCurrencyCodeBytes

      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;
      Returns:
      The bytes for currencyCode.

    • hasOrderId

      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;
      Returns:
      Whether the orderId field is set.

    • getOrderId

      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;
      Returns:
      The orderId.

    • getOrderIdBytes

      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;
      Returns:
      The bytes for orderId.

    • hasExternalAttributionData

      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.v21.services.ExternalAttributionData external_attribution_data = 7;
      Returns:
      Whether the externalAttributionData field is set.

    • getExternalAttributionData

      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.v21.services.ExternalAttributionData external_attribution_data = 7;
      Returns:
      The externalAttributionData.

    • getExternalAttributionDataOrBuilder

      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.v21.services.ExternalAttributionData external_attribution_data = 7;

    • getCustomVariablesList

      List<CustomVariable> getCustomVariablesList()
       The custom variables associated with this conversion.
      repeated .google.ads.googleads.v21.services.CustomVariable custom_variables = 15;

    • getCustomVariables

      CustomVariable getCustomVariables(int index)
       The custom variables associated with this conversion.
      repeated .google.ads.googleads.v21.services.CustomVariable custom_variables = 15;

    • getCustomVariablesCount

      int getCustomVariablesCount()
       The custom variables associated with this conversion.
      repeated .google.ads.googleads.v21.services.CustomVariable custom_variables = 15;

    • getCustomVariablesOrBuilderList

      List<? extends CustomVariableOrBuilder> getCustomVariablesOrBuilderList()
       The custom variables associated with this conversion.
      repeated .google.ads.googleads.v21.services.CustomVariable custom_variables = 15;

    • getCustomVariablesOrBuilder

      CustomVariableOrBuilder getCustomVariablesOrBuilder(int index)
       The custom variables associated with this conversion.
      repeated .google.ads.googleads.v21.services.CustomVariable custom_variables = 15;

    • hasCartData

      boolean hasCartData()
       The cart data associated with this conversion.
      .google.ads.googleads.v21.services.CartData cart_data = 16;
      Returns:
      Whether the cartData field is set.

    • getCartData

      CartData getCartData()
       The cart data associated with this conversion.
      .google.ads.googleads.v21.services.CartData cart_data = 16;
      Returns:
      The cartData.

    • getCartDataOrBuilder

      CartDataOrBuilder getCartDataOrBuilder()
       The cart data associated with this conversion.
      .google.ads.googleads.v21.services.CartData cart_data = 16;

    • getUserIdentifiersList

      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.v21.common.UserIdentifier user_identifiers = 17;

    • getUserIdentifiers

      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.v21.common.UserIdentifier user_identifiers = 17;

    • getUserIdentifiersCount

      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.v21.common.UserIdentifier user_identifiers = 17;

    • getUserIdentifiersOrBuilderList

      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.v21.common.UserIdentifier user_identifiers = 17;

    • getUserIdentifiersOrBuilder

      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.v21.common.UserIdentifier user_identifiers = 17;

    • getConversionEnvironmentValue

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

    • getConversionEnvironment

      ConversionEnvironmentEnum.ConversionEnvironment getConversionEnvironment()
       The environment this conversion was recorded on, for example, App or Web.
      .google.ads.googleads.v21.enums.ConversionEnvironmentEnum.ConversionEnvironment conversion_environment = 20;
      Returns:
      The conversionEnvironment.

    • hasConsent

      boolean hasConsent()
       The consent setting for the event.
      .google.ads.googleads.v21.common.Consent consent = 23;
      Returns:
      Whether the consent field is set.

    • getConsent

      Consent getConsent()
       The consent setting for the event.
      .google.ads.googleads.v21.common.Consent consent = 23;
      Returns:
      The consent.

    • getConsentOrBuilder

      ConsentOrBuilder getConsentOrBuilder()
       The consent setting for the event.
      .google.ads.googleads.v21.common.Consent consent = 23;

    • getCustomerTypeValue

      int getCustomerTypeValue()
       Type of the customer associated with the conversion (new or returning).
 Accessible only to customers on the allow-list.
      .google.ads.googleads.v21.enums.ConversionCustomerTypeEnum.ConversionCustomerType customer_type = 26;
      Returns:
      The enum numeric value on the wire for customerType.

    • getCustomerType

      ConversionCustomerTypeEnum.ConversionCustomerType getCustomerType()
       Type of the customer associated with the conversion (new or returning).
 Accessible only to customers on the allow-list.
      .google.ads.googleads.v21.enums.ConversionCustomerTypeEnum.ConversionCustomerType customer_type = 26;
      Returns:
      The customerType.

    • hasUserIpAddress

      boolean hasUserIpAddress()
       The IP address of the customer when they arrived on the landing page after
 an ad click but before a conversion event. This is the IP address of the
 customer's device, not the advertiser's server. Google Ads does not support
 IP address matching for end users in the European Economic Area (EEA),
 United Kingdom (UK), or Switzerland (CH). Add logic to conditionally
 exclude sharing IP addresses from users from these regions and ensure that
 you provide users with clear and comprehensive information about the data
 you collect on your sites, apps, and other properties and get consent where
 required by law or any applicable Google policies. See the
 https://support.google.com/google-ads/answer/2998031 page for more details.
      optional string user_ip_address = 27 [(.google.api.field_info) = { ... }
      Returns:
      Whether the userIpAddress field is set.

    • getUserIpAddress

      String getUserIpAddress()
       The IP address of the customer when they arrived on the landing page after
 an ad click but before a conversion event. This is the IP address of the
 customer's device, not the advertiser's server. Google Ads does not support
 IP address matching for end users in the European Economic Area (EEA),
 United Kingdom (UK), or Switzerland (CH). Add logic to conditionally
 exclude sharing IP addresses from users from these regions and ensure that
 you provide users with clear and comprehensive information about the data
 you collect on your sites, apps, and other properties and get consent where
 required by law or any applicable Google policies. See the
 https://support.google.com/google-ads/answer/2998031 page for more details.
      optional string user_ip_address = 27 [(.google.api.field_info) = { ... }
      Returns:
      The userIpAddress.

    • getUserIpAddressBytes

      com.google.protobuf.ByteString getUserIpAddressBytes()
       The IP address of the customer when they arrived on the landing page after
 an ad click but before a conversion event. This is the IP address of the
 customer's device, not the advertiser's server. Google Ads does not support
 IP address matching for end users in the European Economic Area (EEA),
 United Kingdom (UK), or Switzerland (CH). Add logic to conditionally
 exclude sharing IP addresses from users from these regions and ensure that
 you provide users with clear and comprehensive information about the data
 you collect on your sites, apps, and other properties and get consent where
 required by law or any applicable Google policies. See the
 https://support.google.com/google-ads/answer/2998031 page for more details.
      optional string user_ip_address = 27 [(.google.api.field_info) = { ... }
      Returns:
      The bytes for userIpAddress.

    • hasSessionAttributesEncoded

      boolean hasSessionAttributesEncoded()
       The session attributes for the event, represented as a base64-encoded
 JSON string. The content should be generated by Google-provided library.
 To set session attributes individually, use
 session_attributes_key_value_pairs instead.
      bytes session_attributes_encoded = 24;
      Returns:
      Whether the sessionAttributesEncoded field is set.

    • getSessionAttributesEncoded

      com.google.protobuf.ByteString getSessionAttributesEncoded()
       The session attributes for the event, represented as a base64-encoded
 JSON string. The content should be generated by Google-provided library.
 To set session attributes individually, use
 session_attributes_key_value_pairs instead.
      bytes session_attributes_encoded = 24;
      Returns:
      The sessionAttributesEncoded.

    • hasSessionAttributesKeyValuePairs

      boolean hasSessionAttributesKeyValuePairs()
       The session attributes for the event, represented as key-value pairs.
      .google.ads.googleads.v21.services.SessionAttributesKeyValuePairs session_attributes_key_value_pairs = 25;
      Returns:
      Whether the sessionAttributesKeyValuePairs field is set.

    • getSessionAttributesKeyValuePairs

      SessionAttributesKeyValuePairs getSessionAttributesKeyValuePairs()
       The session attributes for the event, represented as key-value pairs.
      .google.ads.googleads.v21.services.SessionAttributesKeyValuePairs session_attributes_key_value_pairs = 25;
      Returns:
      The sessionAttributesKeyValuePairs.

    • getSessionAttributesKeyValuePairsOrBuilder

      SessionAttributesKeyValuePairsOrBuilder getSessionAttributesKeyValuePairsOrBuilder()
       The session attributes for the event, represented as key-value pairs.
      .google.ads.googleads.v21.services.SessionAttributesKeyValuePairs session_attributes_key_value_pairs = 25;

    • getSessionAttributesCase

      ClickConversion.SessionAttributesCase getSessionAttributesCase()