Package com.google.ads.googleads.v22.resources

Interface GoalOrBuilder

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

  • Method Details

    • getResourceName

      String getResourceName()
       Immutable. The resource name of the goal.
 Goal resource names have the form:
 `customers/{customer_id}/goals/{goal_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 goal.
 Goal resource names have the form:
 `customers/{customer_id}/goals/{goal_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for resourceName.

    • hasGoalId

      boolean hasGoalId()
       Output only. The ID of this goal.
      optional int64 goal_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the goalId field is set.

    • getGoalId

      long getGoalId()
       Output only. The ID of this goal.
      optional int64 goal_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The goalId.

    • getGoalTypeValue

      int getGoalTypeValue()
       Output only. The type of this goal.
      .google.ads.googleads.v22.enums.GoalTypeEnum.GoalType goal_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for goalType.

    • getGoalType

      GoalTypeEnum.GoalType getGoalType()
       Output only. The type of this goal.
      .google.ads.googleads.v22.enums.GoalTypeEnum.GoalType goal_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The goalType.

    • hasOwnerCustomer

      boolean hasOwnerCustomer()
       Output only. The resource name of the goal owner customer.
      optional string owner_customer = 4 [(.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 goal owner customer.
      optional string owner_customer = 4 [(.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 goal owner customer.
      optional string owner_customer = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for ownerCustomer.

    • getOptimizationEligibilityValue

      int getOptimizationEligibilityValue()
       Output only. Indicates if this goal is eligible for campaign optimization.
      .google.ads.googleads.v22.enums.GoalOptimizationEligibilityEnum.GoalOptimizationEligibility optimization_eligibility = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for optimizationEligibility.

    • getOptimizationEligibility

      GoalOptimizationEligibilityEnum.GoalOptimizationEligibility getOptimizationEligibility()
       Output only. Indicates if this goal is eligible for campaign optimization.
      .google.ads.googleads.v22.enums.GoalOptimizationEligibilityEnum.GoalOptimizationEligibility optimization_eligibility = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The optimizationEligibility.

    • hasRetentionGoalSettings

      boolean hasRetentionGoalSettings()
       Retention goal settings.
      .google.ads.googleads.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
      Returns:
      Whether the retentionGoalSettings field is set.

    • getRetentionGoalSettings

      GoalSetting.RetentionGoal getRetentionGoalSettings()
       Retention goal settings.
      .google.ads.googleads.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
      Returns:
      The retentionGoalSettings.

    • getRetentionGoalSettingsOrBuilder

      GoalSetting.RetentionGoalOrBuilder getRetentionGoalSettingsOrBuilder()
       Retention goal settings.
      .google.ads.googleads.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;

    • getGoalSettingsCase

      Goal.GoalSettingsCase getGoalSettingsCase()