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

Class Goal

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Goal.Builder
    Representation of goals.
    static enum 
    Goal.GoalSettingsCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter, com.google.protobuf.GeneratedMessage.ExtendableMessage.FieldEntry

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    GOAL_ID_FIELD_NUMBER
     
    static final int
    GOAL_TYPE_FIELD_NUMBER
     
    static final int
    OPTIMIZATION_ELIGIBILITY_FIELD_NUMBER
     
    static final int
    OWNER_CUSTOMER_FIELD_NUMBER
     
    static final int
    RESOURCE_NAME_FIELD_NUMBER
     
    static final int
    RETENTION_GOAL_SETTINGS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Goal
    getDefaultInstance()
     
    Goal
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    long
    getGoalId()
    Output only.
    Goal.GoalSettingsCase
    getGoalSettingsCase()
     
    GoalTypeEnum.GoalType
    getGoalType()
    Output only.
    int
    getGoalTypeValue()
    Output only.
    GoalOptimizationEligibilityEnum.GoalOptimizationEligibility
    getOptimizationEligibility()
    Output only.
    int
    getOptimizationEligibilityValue()
    Output only.
    String
    getOwnerCustomer()
    Output only.
    com.google.protobuf.ByteString
    getOwnerCustomerBytes()
    Output only.
    com.google.protobuf.Parser<Goal>
    getParserForType()
     
    String
    getResourceName()
    Immutable.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    Immutable.
    GoalSetting.RetentionGoal
    getRetentionGoalSettings()
    Retention goal settings.
    GoalSetting.RetentionGoalOrBuilder
    getRetentionGoalSettingsOrBuilder()
    Retention goal settings.
    int
    getSerializedSize()
     
    boolean
    hasGoalId()
    Output only.
    int
    hashCode()
     
    boolean
    hasOwnerCustomer()
    Output only.
    boolean
    hasRetentionGoalSettings()
    Retention goal settings.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Goal.Builder
    newBuilder()
     
    static Goal.Builder
    newBuilder(Goal prototype)
     
    Goal.Builder
    newBuilderForType()
     
    protected Goal.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Goal
    parseDelimitedFrom(InputStream input)
     
    static Goal
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Goal
    parseFrom(byte[] data)
     
    static Goal
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Goal
    parseFrom(com.google.protobuf.ByteString data)
     
    static Goal
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Goal
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Goal
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Goal
    parseFrom(InputStream input)
     
    static Goal
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Goal
    parseFrom(ByteBuffer data)
     
    static Goal
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Goal>
    parser()
     
    Goal.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList

    Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    extensionsAreInitialized, extensionsIterator, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder

    getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, hasExtension, hasExtension

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • 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:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • 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.v22.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.v22.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.v22.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.v22.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.v22.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.v22.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.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
      Specified by:
      getRetentionGoalSettingsOrBuilder 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.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>

    • 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.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • 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.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder