com.google.ads.googleads.v17.resources.ConversionActionOrBuilder 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/resources/conversion_action.proto

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

public interface ConversionActionOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.ConversionAction)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Immutable. The resource name of the conversion action.
   * Conversion action resource names have the form:
   *
   * `customers/{customer_id}/conversionActions/{conversion_action_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The resourceName.
   */
  java.lang.String getResourceName();
  /**
   *    * Immutable. The resource name of the conversion action.
   * Conversion action resource names have the form:
   *
   * `customers/{customer_id}/conversionActions/{conversion_action_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Output only. The ID of the conversion action.
   * 
   *
   * optional int64 id = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Output only. The ID of the conversion action.
   * 
   *
   * optional int64 id = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * The name of the conversion action.
   *
   * This field is required and should not be empty when creating new
   * conversion actions.
   * 
   *
   * optional string name = 22;
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * The name of the conversion action.
   *
   * This field is required and should not be empty when creating new
   * conversion actions.
   * 
   *
   * optional string name = 22;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * The name of the conversion action.
   *
   * This field is required and should not be empty when creating new
   * conversion actions.
   * 
   *
   * optional string name = 22;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * The status of this conversion action for conversion event accrual.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionActionStatusEnum.ConversionActionStatus status = 4;
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * The status of this conversion action for conversion event accrual.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionActionStatusEnum.ConversionActionStatus status = 4;
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.ConversionActionStatusEnum.ConversionActionStatus getStatus();

  /**
   *    * Immutable. The type of this conversion action.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionActionTypeEnum.ConversionActionType type = 5 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * Immutable. The type of this conversion action.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionActionTypeEnum.ConversionActionType type = 5 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The type.
   */
  com.google.ads.googleads.v17.enums.ConversionActionTypeEnum.ConversionActionType getType();

  /**
   *    * Output only. The conversion origin of this conversion action.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionOriginEnum.ConversionOrigin origin = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for origin.
   */
  int getOriginValue();
  /**
   *    * Output only. The conversion origin of this conversion action.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionOriginEnum.ConversionOrigin origin = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The origin.
   */
  com.google.ads.googleads.v17.enums.ConversionOriginEnum.ConversionOrigin getOrigin();

  /**
   *    * If a conversion action's primary_for_goal bit is false, the conversion
   * action is non-biddable for all campaigns regardless of their customer
   * conversion goal or campaign conversion goal.
   * However, custom conversion goals do not respect primary_for_goal, so if
   * a campaign has a custom conversion goal configured with a
   * primary_for_goal = false conversion action, that conversion action is
   * still biddable.
   * By default, primary_for_goal will be true if not set. In V9,
   * primary_for_goal can only be set to false after creation through an
   * 'update' operation because it's not declared as optional.
   * 
   *
   * optional bool primary_for_goal = 31;
   * @return Whether the primaryForGoal field is set.
   */
  boolean hasPrimaryForGoal();
  /**
   *    * If a conversion action's primary_for_goal bit is false, the conversion
   * action is non-biddable for all campaigns regardless of their customer
   * conversion goal or campaign conversion goal.
   * However, custom conversion goals do not respect primary_for_goal, so if
   * a campaign has a custom conversion goal configured with a
   * primary_for_goal = false conversion action, that conversion action is
   * still biddable.
   * By default, primary_for_goal will be true if not set. In V9,
   * primary_for_goal can only be set to false after creation through an
   * 'update' operation because it's not declared as optional.
   * 
   *
   * optional bool primary_for_goal = 31;
   * @return The primaryForGoal.
   */
  boolean getPrimaryForGoal();

  /**
   *    * The category of conversions reported for this conversion action.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionActionCategoryEnum.ConversionActionCategory category = 6;
   * @return The enum numeric value on the wire for category.
   */
  int getCategoryValue();
  /**
   *    * The category of conversions reported for this conversion action.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionActionCategoryEnum.ConversionActionCategory category = 6;
   * @return The category.
   */
  com.google.ads.googleads.v17.enums.ConversionActionCategoryEnum.ConversionActionCategory getCategory();

  /**
   *    * Output only. The resource name of the conversion action owner customer, or
   * null if this is a system-defined conversion action.
   * 
   *
   * optional string owner_customer = 23 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return Whether the ownerCustomer field is set.
   */
  boolean hasOwnerCustomer();
  /**
   *    * Output only. The resource name of the conversion action owner customer, or
   * null if this is a system-defined conversion action.
   * 
   *
   * optional string owner_customer = 23 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The ownerCustomer.
   */
  java.lang.String getOwnerCustomer();
  /**
   *    * Output only. The resource name of the conversion action owner customer, or
   * null if this is a system-defined conversion action.
   * 
   *
   * optional string owner_customer = 23 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * @return The bytes for ownerCustomer.
   */
  com.google.protobuf.ByteString
      getOwnerCustomerBytes();

  /**
   *    * Whether this conversion action should be included in the "conversions"
   * metric.
   * 
   *
   * optional bool include_in_conversions_metric = 24;
   * @return Whether the includeInConversionsMetric field is set.
   */
  boolean hasIncludeInConversionsMetric();
  /**
   *    * Whether this conversion action should be included in the "conversions"
   * metric.
   * 
   *
   * optional bool include_in_conversions_metric = 24;
   * @return The includeInConversionsMetric.
   */
  boolean getIncludeInConversionsMetric();

  /**
   *    * The maximum number of days that may elapse between an interaction
   * (for example, a click) and a conversion event.
   * 
   *
   * optional int64 click_through_lookback_window_days = 25;
   * @return Whether the clickThroughLookbackWindowDays field is set.
   */
  boolean hasClickThroughLookbackWindowDays();
  /**
   *    * The maximum number of days that may elapse between an interaction
   * (for example, a click) and a conversion event.
   * 
   *
   * optional int64 click_through_lookback_window_days = 25;
   * @return The clickThroughLookbackWindowDays.
   */
  long getClickThroughLookbackWindowDays();

  /**
   *    * The maximum number of days which may elapse between an impression and a
   * conversion without an interaction.
   * 
   *
   * optional int64 view_through_lookback_window_days = 26;
   * @return Whether the viewThroughLookbackWindowDays field is set.
   */
  boolean hasViewThroughLookbackWindowDays();
  /**
   *    * The maximum number of days which may elapse between an impression and a
   * conversion without an interaction.
   * 
   *
   * optional int64 view_through_lookback_window_days = 26;
   * @return The viewThroughLookbackWindowDays.
   */
  long getViewThroughLookbackWindowDays();

  /**
   *    * Settings related to the value for conversion events associated with this
   * conversion action.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.ValueSettings value_settings = 11;
   * @return Whether the valueSettings field is set.
   */
  boolean hasValueSettings();
  /**
   *    * Settings related to the value for conversion events associated with this
   * conversion action.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.ValueSettings value_settings = 11;
   * @return The valueSettings.
   */
  com.google.ads.googleads.v17.resources.ConversionAction.ValueSettings getValueSettings();
  /**
   *    * Settings related to the value for conversion events associated with this
   * conversion action.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.ValueSettings value_settings = 11;
   */
  com.google.ads.googleads.v17.resources.ConversionAction.ValueSettingsOrBuilder getValueSettingsOrBuilder();

  /**
   *    * How to count conversion events for the conversion action.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionActionCountingTypeEnum.ConversionActionCountingType counting_type = 12;
   * @return The enum numeric value on the wire for countingType.
   */
  int getCountingTypeValue();
  /**
   *    * How to count conversion events for the conversion action.
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionActionCountingTypeEnum.ConversionActionCountingType counting_type = 12;
   * @return The countingType.
   */
  com.google.ads.googleads.v17.enums.ConversionActionCountingTypeEnum.ConversionActionCountingType getCountingType();

  /**
   *    * Settings related to this conversion action's attribution model.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.AttributionModelSettings attribution_model_settings = 13;
   * @return Whether the attributionModelSettings field is set.
   */
  boolean hasAttributionModelSettings();
  /**
   *    * Settings related to this conversion action's attribution model.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.AttributionModelSettings attribution_model_settings = 13;
   * @return The attributionModelSettings.
   */
  com.google.ads.googleads.v17.resources.ConversionAction.AttributionModelSettings getAttributionModelSettings();
  /**
   *    * Settings related to this conversion action's attribution model.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.AttributionModelSettings attribution_model_settings = 13;
   */
  com.google.ads.googleads.v17.resources.ConversionAction.AttributionModelSettingsOrBuilder getAttributionModelSettingsOrBuilder();

  /**
   *    * Output only. The snippets used for tracking conversions.
   * 
   *
   * repeated .google.ads.googleads.v17.common.TagSnippet tag_snippets = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  java.util.List 
      getTagSnippetsList();
  /**
   *    * Output only. The snippets used for tracking conversions.
   * 
   *
   * repeated .google.ads.googleads.v17.common.TagSnippet tag_snippets = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.common.TagSnippet getTagSnippets(int index);
  /**
   *    * Output only. The snippets used for tracking conversions.
   * 
   *
   * repeated .google.ads.googleads.v17.common.TagSnippet tag_snippets = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  int getTagSnippetsCount();
  /**
   *    * Output only. The snippets used for tracking conversions.
   * 
   *
   * repeated .google.ads.googleads.v17.common.TagSnippet tag_snippets = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  java.util.List 
      getTagSnippetsOrBuilderList();
  /**
   *    * Output only. The snippets used for tracking conversions.
   * 
   *
   * repeated .google.ads.googleads.v17.common.TagSnippet tag_snippets = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.common.TagSnippetOrBuilder getTagSnippetsOrBuilder(
      int index);

  /**
   *    * The phone call duration in seconds after which a conversion should be
   * reported for this conversion action.
   *
   * The value must be between 0 and 10000, inclusive.
   * 
   *
   * optional int64 phone_call_duration_seconds = 27;
   * @return Whether the phoneCallDurationSeconds field is set.
   */
  boolean hasPhoneCallDurationSeconds();
  /**
   *    * The phone call duration in seconds after which a conversion should be
   * reported for this conversion action.
   *
   * The value must be between 0 and 10000, inclusive.
   * 
   *
   * optional int64 phone_call_duration_seconds = 27;
   * @return The phoneCallDurationSeconds.
   */
  long getPhoneCallDurationSeconds();

  /**
   *    * App ID for an app conversion action.
   * 
   *
   * optional string app_id = 28;
   * @return Whether the appId field is set.
   */
  boolean hasAppId();
  /**
   *    * App ID for an app conversion action.
   * 
   *
   * optional string app_id = 28;
   * @return The appId.
   */
  java.lang.String getAppId();
  /**
   *    * App ID for an app conversion action.
   * 
   *
   * optional string app_id = 28;
   * @return The bytes for appId.
   */
  com.google.protobuf.ByteString
      getAppIdBytes();

  /**
   *    * Output only. Mobile app vendor for an app conversion action.
   * 
   *
   * .google.ads.googleads.v17.enums.MobileAppVendorEnum.MobileAppVendor mobile_app_vendor = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for mobileAppVendor.
   */
  int getMobileAppVendorValue();
  /**
   *    * Output only. Mobile app vendor for an app conversion action.
   * 
   *
   * .google.ads.googleads.v17.enums.MobileAppVendorEnum.MobileAppVendor mobile_app_vendor = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The mobileAppVendor.
   */
  com.google.ads.googleads.v17.enums.MobileAppVendorEnum.MobileAppVendor getMobileAppVendor();

  /**
   *    * Output only. Firebase settings for Firebase conversion types.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.FirebaseSettings firebase_settings = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the firebaseSettings field is set.
   */
  boolean hasFirebaseSettings();
  /**
   *    * Output only. Firebase settings for Firebase conversion types.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.FirebaseSettings firebase_settings = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The firebaseSettings.
   */
  com.google.ads.googleads.v17.resources.ConversionAction.FirebaseSettings getFirebaseSettings();
  /**
   *    * Output only. Firebase settings for Firebase conversion types.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.FirebaseSettings firebase_settings = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.ConversionAction.FirebaseSettingsOrBuilder getFirebaseSettingsOrBuilder();

  /**
   *    * Output only. Third Party App Analytics settings for third party conversion
   * types.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.ThirdPartyAppAnalyticsSettings third_party_app_analytics_settings = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the thirdPartyAppAnalyticsSettings field is set.
   */
  boolean hasThirdPartyAppAnalyticsSettings();
  /**
   *    * Output only. Third Party App Analytics settings for third party conversion
   * types.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.ThirdPartyAppAnalyticsSettings third_party_app_analytics_settings = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The thirdPartyAppAnalyticsSettings.
   */
  com.google.ads.googleads.v17.resources.ConversionAction.ThirdPartyAppAnalyticsSettings getThirdPartyAppAnalyticsSettings();
  /**
   *    * Output only. Third Party App Analytics settings for third party conversion
   * types.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.ThirdPartyAppAnalyticsSettings third_party_app_analytics_settings = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.ConversionAction.ThirdPartyAppAnalyticsSettingsOrBuilder getThirdPartyAppAnalyticsSettingsOrBuilder();

  /**
   *    * Output only. Google Analytics 4 settings for Google Analytics 4 conversion
   * types.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.GoogleAnalytics4Settings google_analytics_4_settings = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the googleAnalytics4Settings field is set.
   */
  boolean hasGoogleAnalytics4Settings();
  /**
   *    * Output only. Google Analytics 4 settings for Google Analytics 4 conversion
   * types.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.GoogleAnalytics4Settings google_analytics_4_settings = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The googleAnalytics4Settings.
   */
  com.google.ads.googleads.v17.resources.ConversionAction.GoogleAnalytics4Settings getGoogleAnalytics4Settings();
  /**
   *    * Output only. Google Analytics 4 settings for Google Analytics 4 conversion
   * types.
   * 
   *
   * .google.ads.googleads.v17.resources.ConversionAction.GoogleAnalytics4Settings google_analytics_4_settings = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.resources.ConversionAction.GoogleAnalytics4SettingsOrBuilder getGoogleAnalytics4SettingsOrBuilder();
}