com.google.ads.googleads.v17.services.ClickConversionOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/services/conversion_upload_service.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.services;

public interface ClickConversionOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.services.ClickConversion)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The Google click ID (gclid) associated with this conversion.
   * 
   *
   * optional string gclid = 9;
   * @return Whether the gclid field is set.
   */
  boolean hasGclid();
  /**
   *    * The Google click ID (gclid) associated with this conversion.
   * 
   *
   * optional string gclid = 9;
   * @return The gclid.
   */
  java.lang.String getGclid();
  /**
   *    * The Google click ID (gclid) associated with this conversion.
   * 
   *
   * optional string gclid = 9;
   * @return The bytes for gclid.
   */
  com.google.protobuf.ByteString
      getGclidBytes();

  /**
   *    * The click identifier for clicks associated with app conversions and
   * originating from iOS devices starting with iOS14.
   * 
   *
   * string gbraid = 18;
   * @return The gbraid.
   */
  java.lang.String getGbraid();
  /**
   *    * The click identifier for clicks associated with app conversions and
   * originating from iOS devices starting with iOS14.
   * 
   *
   * string gbraid = 18;
   * @return The bytes for gbraid.
   */
  com.google.protobuf.ByteString
      getGbraidBytes();

  /**
   *    * The click identifier for clicks associated with web conversions and
   * originating from iOS devices starting with iOS14.
   * 
   *
   * string wbraid = 19;
   * @return The wbraid.
   */
  java.lang.String getWbraid();
  /**
   *    * The click identifier for clicks associated with web conversions and
   * originating from iOS devices starting with iOS14.
   * 
   *
   * string wbraid = 19;
   * @return The bytes for wbraid.
   */
  com.google.protobuf.ByteString
      getWbraidBytes();

  /**
   *    * 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;
   * @return Whether the conversionAction field is set.
   */
  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;
   * @return The conversionAction.
   */
  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;
   * @return The bytes for conversionAction.
   */
  com.google.protobuf.ByteString
      getConversionActionBytes();

  /**
   *    * 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;
   * @return Whether the conversionDateTime field is set.
   */
  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;
   * @return The conversionDateTime.
   */
  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", for example, "2019-01-01 12:32:45-08:00".
   * 
   *
   * optional string conversion_date_time = 11;
   * @return The bytes for conversionDateTime.
   */
  com.google.protobuf.ByteString
      getConversionDateTimeBytes();

  /**
   *    * The value of the conversion for the advertiser.
   * 
   *
   * optional double conversion_value = 12;
   * @return Whether the conversionValue field is set.
   */
  boolean hasConversionValue();
  /**
   *    * The value of the conversion for the advertiser.
   * 
   *
   * optional double conversion_value = 12;
   * @return The conversionValue.
   */
  double getConversionValue();

  /**
   *    * Currency associated with the conversion value. This is the ISO 4217
   * 3-character currency code. For example: USD, EUR.
   * 
   *
   * optional string currency_code = 13;
   * @return Whether the currencyCode field is set.
   */
  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;
   * @return The currencyCode.
   */
  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;
   * @return The bytes for currencyCode.
   */
  com.google.protobuf.ByteString
      getCurrencyCodeBytes();

  /**
   *    * 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;
   * @return Whether the orderId field is set.
   */
  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;
   * @return The orderId.
   */
  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;
   * @return The bytes for orderId.
   */
  com.google.protobuf.ByteString
      getOrderIdBytes();

  /**
   *    * 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.v17.services.ExternalAttributionData external_attribution_data = 7;
   * @return Whether the externalAttributionData field is set.
   */
  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.v17.services.ExternalAttributionData external_attribution_data = 7;
   * @return The externalAttributionData.
   */
  com.google.ads.googleads.v17.services.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.v17.services.ExternalAttributionData external_attribution_data = 7;
   */
  com.google.ads.googleads.v17.services.ExternalAttributionDataOrBuilder getExternalAttributionDataOrBuilder();

  /**
   *    * The custom variables associated with this conversion.
   * 
   *
   * repeated .google.ads.googleads.v17.services.CustomVariable custom_variables = 15;
   */
  java.util.List 
      getCustomVariablesList();
  /**
   *    * The custom variables associated with this conversion.
   * 
   *
   * repeated .google.ads.googleads.v17.services.CustomVariable custom_variables = 15;
   */
  com.google.ads.googleads.v17.services.CustomVariable getCustomVariables(int index);
  /**
   *    * The custom variables associated with this conversion.
   * 
   *
   * repeated .google.ads.googleads.v17.services.CustomVariable custom_variables = 15;
   */
  int getCustomVariablesCount();
  /**
   *    * The custom variables associated with this conversion.
   * 
   *
   * repeated .google.ads.googleads.v17.services.CustomVariable custom_variables = 15;
   */
  java.util.List 
      getCustomVariablesOrBuilderList();
  /**
   *    * The custom variables associated with this conversion.
   * 
   *
   * repeated .google.ads.googleads.v17.services.CustomVariable custom_variables = 15;
   */
  com.google.ads.googleads.v17.services.CustomVariableOrBuilder getCustomVariablesOrBuilder(
      int index);

  /**
   *    * The cart data associated with this conversion.
   * 
   *
   * .google.ads.googleads.v17.services.CartData cart_data = 16;
   * @return Whether the cartData field is set.
   */
  boolean hasCartData();
  /**
   *    * The cart data associated with this conversion.
   * 
   *
   * .google.ads.googleads.v17.services.CartData cart_data = 16;
   * @return The cartData.
   */
  com.google.ads.googleads.v17.services.CartData getCartData();
  /**
   *    * The cart data associated with this conversion.
   * 
   *
   * .google.ads.googleads.v17.services.CartData cart_data = 16;
   */
  com.google.ads.googleads.v17.services.CartDataOrBuilder getCartDataOrBuilder();

  /**
   *    * 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.v17.common.UserIdentifier user_identifiers = 17;
   */
  java.util.List 
      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.v17.common.UserIdentifier user_identifiers = 17;
   */
  com.google.ads.googleads.v17.common.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.v17.common.UserIdentifier user_identifiers = 17;
   */
  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.v17.common.UserIdentifier user_identifiers = 17;
   */
  java.util.List 
      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.v17.common.UserIdentifier user_identifiers = 17;
   */
  com.google.ads.googleads.v17.common.UserIdentifierOrBuilder getUserIdentifiersOrBuilder(
      int index);

  /**
   *    * The environment this conversion was recorded on, for example, App or Web.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionEnvironmentEnum.ConversionEnvironment conversion_environment = 20;
   * @return The enum numeric value on the wire for conversionEnvironment.
   */
  int getConversionEnvironmentValue();
  /**
   *    * The environment this conversion was recorded on, for example, App or Web.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionEnvironmentEnum.ConversionEnvironment conversion_environment = 20;
   * @return The conversionEnvironment.
   */
  com.google.ads.googleads.v17.enums.ConversionEnvironmentEnum.ConversionEnvironment getConversionEnvironment();

  /**
   *    * The consent setting for the event.
   * 
   *
   * .google.ads.googleads.v17.common.Consent consent = 23;
   * @return Whether the consent field is set.
   */
  boolean hasConsent();
  /**
   *    * The consent setting for the event.
   * 
   *
   * .google.ads.googleads.v17.common.Consent consent = 23;
   * @return The consent.
   */
  com.google.ads.googleads.v17.common.Consent getConsent();
  /**
   *    * The consent setting for the event.
   * 
   *
   * .google.ads.googleads.v17.common.Consent consent = 23;
   */
  com.google.ads.googleads.v17.common.ConsentOrBuilder getConsentOrBuilder();
}