Package com.google.ads.googleads.v18.resources

Interface ConversionActionOrBuilder

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

  • Method Details

    • getResourceName

      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) = { ... }
      Returns:
      The resourceName.

    • getResourceNameBytes

      com.google.protobuf.ByteString getResourceNameBytes()
       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) = { ... }
      Returns:
      The bytes for resourceName.

    • hasId

      boolean hasId()
       Output only. The ID of the conversion action.
      optional int64 id = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the id field is set.

    • getId

      long getId()
       Output only. The ID of the conversion action.
      optional int64 id = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.

    • hasName

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

    • getName

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

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the conversion action.

 This field is required and should not be empty when creating new
 conversion actions.
      optional string name = 22;
      Returns:
      The bytes for name.

    • getStatusValue

      int getStatusValue()
       The status of this conversion action for conversion event accrual.
      .google.ads.googleads.v18.enums.ConversionActionStatusEnum.ConversionActionStatus status = 4;
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      ConversionActionStatusEnum.ConversionActionStatus getStatus()
       The status of this conversion action for conversion event accrual.
      .google.ads.googleads.v18.enums.ConversionActionStatusEnum.ConversionActionStatus status = 4;
      Returns:
      The status.

    • getTypeValue

      int getTypeValue()
       Immutable. The type of this conversion action.
      .google.ads.googleads.v18.enums.ConversionActionTypeEnum.ConversionActionType type = 5 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      ConversionActionTypeEnum.ConversionActionType getType()
       Immutable. The type of this conversion action.
      .google.ads.googleads.v18.enums.ConversionActionTypeEnum.ConversionActionType type = 5 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The type.

    • getOriginValue

      int getOriginValue()
       Output only. The conversion origin of this conversion action.
      .google.ads.googleads.v18.enums.ConversionOriginEnum.ConversionOrigin origin = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for origin.

    • getOrigin

      ConversionOriginEnum.ConversionOrigin getOrigin()
       Output only. The conversion origin of this conversion action.
      .google.ads.googleads.v18.enums.ConversionOriginEnum.ConversionOrigin origin = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The origin.

    • hasPrimaryForGoal

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

    • getPrimaryForGoal

      boolean getPrimaryForGoal()
       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;
      Returns:
      The primaryForGoal.

    • getCategoryValue

      int getCategoryValue()
       The category of conversions reported for this conversion action.
      .google.ads.googleads.v18.enums.ConversionActionCategoryEnum.ConversionActionCategory category = 6;
      Returns:
      The enum numeric value on the wire for category.

    • getCategory

      ConversionActionCategoryEnum.ConversionActionCategory getCategory()
       The category of conversions reported for this conversion action.
      .google.ads.googleads.v18.enums.ConversionActionCategoryEnum.ConversionActionCategory category = 6;
      Returns:
      The category.

    • hasOwnerCustomer

      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) = { ... }
      Returns:
      Whether the ownerCustomer field is set.

    • getOwnerCustomer

      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) = { ... }
      Returns:
      The ownerCustomer.

    • getOwnerCustomerBytes

      com.google.protobuf.ByteString getOwnerCustomerBytes()
       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) = { ... }
      Returns:
      The bytes for ownerCustomer.

    • hasIncludeInConversionsMetric

      boolean hasIncludeInConversionsMetric()
       Whether this conversion action should be included in the "conversions"
 metric.
      optional bool include_in_conversions_metric = 24;
      Returns:
      Whether the includeInConversionsMetric field is set.

    • getIncludeInConversionsMetric

      boolean getIncludeInConversionsMetric()
       Whether this conversion action should be included in the "conversions"
 metric.
      optional bool include_in_conversions_metric = 24;
      Returns:
      The includeInConversionsMetric.

    • hasClickThroughLookbackWindowDays

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

    • getClickThroughLookbackWindowDays

      long getClickThroughLookbackWindowDays()
       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;
      Returns:
      The clickThroughLookbackWindowDays.

    • hasViewThroughLookbackWindowDays

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

    • getViewThroughLookbackWindowDays

      long getViewThroughLookbackWindowDays()
       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;
      Returns:
      The viewThroughLookbackWindowDays.

    • hasValueSettings

      boolean hasValueSettings()
       Settings related to the value for conversion events associated with this
 conversion action.
      .google.ads.googleads.v18.resources.ConversionAction.ValueSettings value_settings = 11;
      Returns:
      Whether the valueSettings field is set.

    • getValueSettings

      ConversionAction.ValueSettings getValueSettings()
       Settings related to the value for conversion events associated with this
 conversion action.
      .google.ads.googleads.v18.resources.ConversionAction.ValueSettings value_settings = 11;
      Returns:
      The valueSettings.

    • getValueSettingsOrBuilder

      ConversionAction.ValueSettingsOrBuilder getValueSettingsOrBuilder()
       Settings related to the value for conversion events associated with this
 conversion action.
      .google.ads.googleads.v18.resources.ConversionAction.ValueSettings value_settings = 11;

    • getCountingTypeValue

      int getCountingTypeValue()
       How to count conversion events for the conversion action.
      .google.ads.googleads.v18.enums.ConversionActionCountingTypeEnum.ConversionActionCountingType counting_type = 12;
      Returns:
      The enum numeric value on the wire for countingType.

    • getCountingType

      ConversionActionCountingTypeEnum.ConversionActionCountingType getCountingType()
       How to count conversion events for the conversion action.
      .google.ads.googleads.v18.enums.ConversionActionCountingTypeEnum.ConversionActionCountingType counting_type = 12;
      Returns:
      The countingType.

    • hasAttributionModelSettings

      boolean hasAttributionModelSettings()
       Settings related to this conversion action's attribution model.
      .google.ads.googleads.v18.resources.ConversionAction.AttributionModelSettings attribution_model_settings = 13;
      Returns:
      Whether the attributionModelSettings field is set.

    • getAttributionModelSettings

      ConversionAction.AttributionModelSettings getAttributionModelSettings()
       Settings related to this conversion action's attribution model.
      .google.ads.googleads.v18.resources.ConversionAction.AttributionModelSettings attribution_model_settings = 13;
      Returns:
      The attributionModelSettings.

    • getAttributionModelSettingsOrBuilder

      ConversionAction.AttributionModelSettingsOrBuilder getAttributionModelSettingsOrBuilder()
       Settings related to this conversion action's attribution model.
      .google.ads.googleads.v18.resources.ConversionAction.AttributionModelSettings attribution_model_settings = 13;

    • getTagSnippetsList

      List<TagSnippet> getTagSnippetsList()
       Output only. The snippets used for tracking conversions.
      repeated .google.ads.googleads.v18.common.TagSnippet tag_snippets = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getTagSnippets

      TagSnippet getTagSnippets(int index)
       Output only. The snippets used for tracking conversions.
      repeated .google.ads.googleads.v18.common.TagSnippet tag_snippets = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getTagSnippetsCount

      int getTagSnippetsCount()
       Output only. The snippets used for tracking conversions.
      repeated .google.ads.googleads.v18.common.TagSnippet tag_snippets = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getTagSnippetsOrBuilderList

      List<? extends TagSnippetOrBuilder> getTagSnippetsOrBuilderList()
       Output only. The snippets used for tracking conversions.
      repeated .google.ads.googleads.v18.common.TagSnippet tag_snippets = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getTagSnippetsOrBuilder

      TagSnippetOrBuilder getTagSnippetsOrBuilder(int index)
       Output only. The snippets used for tracking conversions.
      repeated .google.ads.googleads.v18.common.TagSnippet tag_snippets = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasPhoneCallDurationSeconds

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

    • getPhoneCallDurationSeconds

      long getPhoneCallDurationSeconds()
       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;
      Returns:
      The phoneCallDurationSeconds.

    • hasAppId

      boolean hasAppId()
       App ID for an app conversion action.
      optional string app_id = 28;
      Returns:
      Whether the appId field is set.

    • getAppId

      String getAppId()
       App ID for an app conversion action.
      optional string app_id = 28;
      Returns:
      The appId.

    • getAppIdBytes

      com.google.protobuf.ByteString getAppIdBytes()
       App ID for an app conversion action.
      optional string app_id = 28;
      Returns:
      The bytes for appId.

    • getMobileAppVendorValue

      int getMobileAppVendorValue()
       Output only. Mobile app vendor for an app conversion action.
      .google.ads.googleads.v18.enums.MobileAppVendorEnum.MobileAppVendor mobile_app_vendor = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for mobileAppVendor.

    • getMobileAppVendor

      MobileAppVendorEnum.MobileAppVendor getMobileAppVendor()
       Output only. Mobile app vendor for an app conversion action.
      .google.ads.googleads.v18.enums.MobileAppVendorEnum.MobileAppVendor mobile_app_vendor = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The mobileAppVendor.

    • hasFirebaseSettings

      boolean hasFirebaseSettings()
       Output only. Firebase settings for Firebase conversion types.
      .google.ads.googleads.v18.resources.ConversionAction.FirebaseSettings firebase_settings = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the firebaseSettings field is set.

    • getFirebaseSettings

      ConversionAction.FirebaseSettings getFirebaseSettings()
       Output only. Firebase settings for Firebase conversion types.
      .google.ads.googleads.v18.resources.ConversionAction.FirebaseSettings firebase_settings = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The firebaseSettings.

    • getFirebaseSettingsOrBuilder

      ConversionAction.FirebaseSettingsOrBuilder getFirebaseSettingsOrBuilder()
       Output only. Firebase settings for Firebase conversion types.
      .google.ads.googleads.v18.resources.ConversionAction.FirebaseSettings firebase_settings = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasThirdPartyAppAnalyticsSettings

      boolean hasThirdPartyAppAnalyticsSettings()
       Output only. Third Party App Analytics settings for third party conversion
 types.
      .google.ads.googleads.v18.resources.ConversionAction.ThirdPartyAppAnalyticsSettings third_party_app_analytics_settings = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the thirdPartyAppAnalyticsSettings field is set.

    • getThirdPartyAppAnalyticsSettings

      ConversionAction.ThirdPartyAppAnalyticsSettings getThirdPartyAppAnalyticsSettings()
       Output only. Third Party App Analytics settings for third party conversion
 types.
      .google.ads.googleads.v18.resources.ConversionAction.ThirdPartyAppAnalyticsSettings third_party_app_analytics_settings = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The thirdPartyAppAnalyticsSettings.

    • getThirdPartyAppAnalyticsSettingsOrBuilder

      ConversionAction.ThirdPartyAppAnalyticsSettingsOrBuilder getThirdPartyAppAnalyticsSettingsOrBuilder()
       Output only. Third Party App Analytics settings for third party conversion
 types.
      .google.ads.googleads.v18.resources.ConversionAction.ThirdPartyAppAnalyticsSettings third_party_app_analytics_settings = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasGoogleAnalytics4Settings

      boolean hasGoogleAnalytics4Settings()
       Output only. Google Analytics 4 settings for Google Analytics 4 conversion
 types.
      .google.ads.googleads.v18.resources.ConversionAction.GoogleAnalytics4Settings google_analytics_4_settings = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the googleAnalytics4Settings field is set.

    • getGoogleAnalytics4Settings

      ConversionAction.GoogleAnalytics4Settings getGoogleAnalytics4Settings()
       Output only. Google Analytics 4 settings for Google Analytics 4 conversion
 types.
      .google.ads.googleads.v18.resources.ConversionAction.GoogleAnalytics4Settings google_analytics_4_settings = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The googleAnalytics4Settings.

    • getGoogleAnalytics4SettingsOrBuilder

      ConversionAction.GoogleAnalytics4SettingsOrBuilder getGoogleAnalytics4SettingsOrBuilder()
       Output only. Google Analytics 4 settings for Google Analytics 4 conversion
 types.
      .google.ads.googleads.v18.resources.ConversionAction.GoogleAnalytics4Settings google_analytics_4_settings = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];