Package com.google.ads.googleads.v25.resources

Class Goal

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ads.googleads.v25.resources.Goal
All Implemented Interfaces:
GoalOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Goal extends com.google.protobuf.GeneratedMessage implements GoalOrBuilder
 Representation of goals.
Protobuf type google.ads.googleads.v25.resources.Goal
See Also:

  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • GOAL_ID_FIELD_NUMBER

      public static final int GOAL_ID_FIELD_NUMBER
      See Also:

    • GOAL_TYPE_FIELD_NUMBER

      public static final int GOAL_TYPE_FIELD_NUMBER
      See Also:

    • OWNER_CUSTOMER_FIELD_NUMBER

      public static final int OWNER_CUSTOMER_FIELD_NUMBER
      See Also:

    • OPTIMIZATION_ELIGIBILITY_FIELD_NUMBER

      public static final int OPTIMIZATION_ELIGIBILITY_FIELD_NUMBER
      See Also:

    • RETENTION_GOAL_SETTINGS_FIELD_NUMBER

      public static final int RETENTION_GOAL_SETTINGS_FIELD_NUMBER
      See Also:

    • NEW_CUSTOMER_ACQUISITION_GOAL_SETTINGS_FIELD_NUMBER

      public static final int NEW_CUSTOMER_ACQUISITION_GOAL_SETTINGS_FIELD_NUMBER
      See Also:

    • LOYALTY_RETENTION_GOAL_SETTINGS_FIELD_NUMBER

      public static final int LOYALTY_RETENTION_GOAL_SETTINGS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getGoalSettingsCase

      public Goal.GoalSettingsCase getGoalSettingsCase()
      Specified by:
      getGoalSettingsCase in interface GoalOrBuilder

    • getResourceName

      public 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) = { ... }
      Specified by:
      getResourceName in interface GoalOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public 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) = { ... }
      Specified by:
      getResourceNameBytes in interface GoalOrBuilder
      Returns:
      The bytes for resourceName.

    • hasGoalId

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

    • getGoalId

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

    • getGoalTypeValue

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

    • getGoalType

      public GoalTypeEnum.GoalType getGoalType()
       Output only. The type of this goal.
      .google.ads.googleads.v25.enums.GoalTypeEnum.GoalType goal_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGoalType in interface GoalOrBuilder
      Returns:
      The goalType.

    • hasOwnerCustomer

      public 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) = { ... }
      Specified by:
      hasOwnerCustomer in interface GoalOrBuilder
      Returns:
      Whether the ownerCustomer field is set.

    • getOwnerCustomer

      public 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) = { ... }
      Specified by:
      getOwnerCustomer in interface GoalOrBuilder
      Returns:
      The ownerCustomer.

    • getOwnerCustomerBytes

      public 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) = { ... }
      Specified by:
      getOwnerCustomerBytes in interface GoalOrBuilder
      Returns:
      The bytes for ownerCustomer.

    • getOptimizationEligibilityValue

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

    • getOptimizationEligibility

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

    • hasRetentionGoalSettings

      public boolean hasRetentionGoalSettings()
       Retention goal settings.
      .google.ads.googleads.v25.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
      Specified by:
      hasRetentionGoalSettings in interface GoalOrBuilder
      Returns:
      Whether the retentionGoalSettings field is set.

    • getRetentionGoalSettings

      public GoalSetting.RetentionGoal getRetentionGoalSettings()
       Retention goal settings.
      .google.ads.googleads.v25.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
      Specified by:
      getRetentionGoalSettings in interface GoalOrBuilder
      Returns:
      The retentionGoalSettings.

    • getRetentionGoalSettingsOrBuilder

      public GoalSetting.RetentionGoalOrBuilder getRetentionGoalSettingsOrBuilder()
       Retention goal settings.
      .google.ads.googleads.v25.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
      Specified by:
      getRetentionGoalSettingsOrBuilder in interface GoalOrBuilder

    • hasNewCustomerAcquisitionGoalSettings

      public boolean hasNewCustomerAcquisitionGoalSettings()
       New customer acquisition goal settings.
      .google.ads.googleads.v25.common.GoalSetting.NewCustomerAcquisitionGoal new_customer_acquisition_goal_settings = 8;
      Specified by:
      hasNewCustomerAcquisitionGoalSettings in interface GoalOrBuilder
      Returns:
      Whether the newCustomerAcquisitionGoalSettings field is set.

    • getNewCustomerAcquisitionGoalSettings

      public GoalSetting.NewCustomerAcquisitionGoal getNewCustomerAcquisitionGoalSettings()
       New customer acquisition goal settings.
      .google.ads.googleads.v25.common.GoalSetting.NewCustomerAcquisitionGoal new_customer_acquisition_goal_settings = 8;
      Specified by:
      getNewCustomerAcquisitionGoalSettings in interface GoalOrBuilder
      Returns:
      The newCustomerAcquisitionGoalSettings.

    • getNewCustomerAcquisitionGoalSettingsOrBuilder

      public GoalSetting.NewCustomerAcquisitionGoalOrBuilder getNewCustomerAcquisitionGoalSettingsOrBuilder()
       New customer acquisition goal settings.
      .google.ads.googleads.v25.common.GoalSetting.NewCustomerAcquisitionGoal new_customer_acquisition_goal_settings = 8;
      Specified by:
      getNewCustomerAcquisitionGoalSettingsOrBuilder in interface GoalOrBuilder

    • hasLoyaltyRetentionGoalSettings

      public boolean hasLoyaltyRetentionGoalSettings()
       Loyalty retention goal settings.
      .google.ads.googleads.v25.common.GoalSetting.LoyaltyRetentionGoal loyalty_retention_goal_settings = 9;
      Specified by:
      hasLoyaltyRetentionGoalSettings in interface GoalOrBuilder
      Returns:
      Whether the loyaltyRetentionGoalSettings field is set.

    • getLoyaltyRetentionGoalSettings

      public GoalSetting.LoyaltyRetentionGoal getLoyaltyRetentionGoalSettings()
       Loyalty retention goal settings.
      .google.ads.googleads.v25.common.GoalSetting.LoyaltyRetentionGoal loyalty_retention_goal_settings = 9;
      Specified by:
      getLoyaltyRetentionGoalSettings in interface GoalOrBuilder
      Returns:
      The loyaltyRetentionGoalSettings.

    • getLoyaltyRetentionGoalSettingsOrBuilder

      public GoalSetting.LoyaltyRetentionGoalOrBuilder getLoyaltyRetentionGoalSettingsOrBuilder()
       Loyalty retention goal settings.
      .google.ads.googleads.v25.common.GoalSetting.LoyaltyRetentionGoal loyalty_retention_goal_settings = 9;
      Specified by:
      getLoyaltyRetentionGoalSettingsOrBuilder in interface GoalOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Goal parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Goal parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Goal parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Goal parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Goal parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Goal parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Goal parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Goal parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Goal parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Goal parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Goal parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Goal parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Goal.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Goal.Builder newBuilder()

    • newBuilder

      public static Goal.Builder newBuilder(Goal prototype)

    • toBuilder

      public Goal.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Goal.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Goal getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Goal> parser()

    • getParserForType

      public com.google.protobuf.Parser<Goal> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Goal getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder