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

Class CampaignGoalConfig

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.CampaignGoalConfig
All Implemented Interfaces:
CampaignGoalConfigOrBuilder, 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 CampaignGoalConfig extends com.google.protobuf.GeneratedMessageV3 implements CampaignGoalConfigOrBuilder
 A link between a campaign and a goal enabling campaign-specific optimization.
Protobuf type google.ads.googleads.v22.resources.CampaignGoalConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CampaignGoalConfig.Builder
    A link between a campaign and a goal enabling campaign-specific optimization.
    static enum 
    CampaignGoalConfig.CampaignGoalConfigSettingsCase
     

    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
    CAMPAIGN_FIELD_NUMBER
     
    static final int
    CAMPAIGN_RETENTION_SETTINGS_FIELD_NUMBER
     
    static final int
    GOAL_FIELD_NUMBER
     
    static final int
    GOAL_TYPE_FIELD_NUMBER
     
    static final int
    RESOURCE_NAME_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)
     
    String
    getCampaign()
    Immutable.
    com.google.protobuf.ByteString
    getCampaignBytes()
    Immutable.
    CampaignGoalConfig.CampaignGoalConfigSettingsCase
    getCampaignGoalConfigSettingsCase()
     
    CampaignGoalSettings.CampaignRetentionGoalSettings
    getCampaignRetentionSettings()
    Retention goal campaign settings.
    CampaignGoalSettings.CampaignRetentionGoalSettingsOrBuilder
    getCampaignRetentionSettingsOrBuilder()
    Retention goal campaign settings.
    static CampaignGoalConfig
    getDefaultInstance()
     
    CampaignGoalConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getGoal()
    Immutable.
    com.google.protobuf.ByteString
    getGoalBytes()
    Immutable.
    GoalTypeEnum.GoalType
    getGoalType()
    Output only.
    int
    getGoalTypeValue()
    Output only.
    com.google.protobuf.Parser<CampaignGoalConfig>
    getParserForType()
     
    String
    getResourceName()
    Immutable.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    Immutable.
    int
    getSerializedSize()
     
    boolean
    hasCampaignRetentionSettings()
    Retention goal campaign settings.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CampaignGoalConfig.Builder
    newBuilder()
     
    static CampaignGoalConfig.Builder
    newBuilder(CampaignGoalConfig prototype)
     
    CampaignGoalConfig.Builder
    newBuilderForType()
     
    protected CampaignGoalConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static CampaignGoalConfig
    parseDelimitedFrom(InputStream input)
     
    static CampaignGoalConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CampaignGoalConfig
    parseFrom(byte[] data)
     
    static CampaignGoalConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CampaignGoalConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static CampaignGoalConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CampaignGoalConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CampaignGoalConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CampaignGoalConfig
    parseFrom(InputStream input)
     
    static CampaignGoalConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CampaignGoalConfig
    parseFrom(ByteBuffer data)
     
    static CampaignGoalConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CampaignGoalConfig>
    parser()
     
    CampaignGoalConfig.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:

    • CAMPAIGN_FIELD_NUMBER

      public static final int CAMPAIGN_FIELD_NUMBER
      See Also:

    • GOAL_FIELD_NUMBER

      public static final int GOAL_FIELD_NUMBER
      See Also:

    • GOAL_TYPE_FIELD_NUMBER

      public static final int GOAL_TYPE_FIELD_NUMBER
      See Also:

    • CAMPAIGN_RETENTION_SETTINGS_FIELD_NUMBER

      public static final int CAMPAIGN_RETENTION_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

    • getCampaignGoalConfigSettingsCase

      public CampaignGoalConfig.CampaignGoalConfigSettingsCase getCampaignGoalConfigSettingsCase()
      Specified by:
      getCampaignGoalConfigSettingsCase in interface CampaignGoalConfigOrBuilder

    • getResourceName

      public String getResourceName()
       Immutable. The resource name of the campaign goal config.
 campaign goal config resource names have the form:
 `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceName in interface CampaignGoalConfigOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       Immutable. The resource name of the campaign goal config.
 campaign goal config resource names have the form:
 `customers/{customer_id}/campaignGoalConfigs/{campaign_id}~{goal_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface CampaignGoalConfigOrBuilder
      Returns:
      The bytes for resourceName.

    • getCampaign

      public String getCampaign()
       Immutable. The resource name of the campaign for this link.
      string campaign = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getCampaign in interface CampaignGoalConfigOrBuilder
      Returns:
      The campaign.

    • getCampaignBytes

      public com.google.protobuf.ByteString getCampaignBytes()
       Immutable. The resource name of the campaign for this link.
      string campaign = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getCampaignBytes in interface CampaignGoalConfigOrBuilder
      Returns:
      The bytes for campaign.

    • getGoal

      public String getGoal()
       Immutable. The resource name of the goal this link is attached to.
      string goal = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getGoal in interface CampaignGoalConfigOrBuilder
      Returns:
      The goal.

    • getGoalBytes

      public com.google.protobuf.ByteString getGoalBytes()
       Immutable. The resource name of the goal this link is attached to.
      string goal = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getGoalBytes in interface CampaignGoalConfigOrBuilder
      Returns:
      The bytes for goal.

    • getGoalTypeValue

      public int getGoalTypeValue()
       Output only. The goal type this link is attached to.
      .google.ads.googleads.v22.enums.GoalTypeEnum.GoalType goal_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGoalTypeValue in interface CampaignGoalConfigOrBuilder
      Returns:
      The enum numeric value on the wire for goalType.

    • getGoalType

      public GoalTypeEnum.GoalType getGoalType()
       Output only. The goal type this link is attached to.
      .google.ads.googleads.v22.enums.GoalTypeEnum.GoalType goal_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGoalType in interface CampaignGoalConfigOrBuilder
      Returns:
      The goalType.

    • hasCampaignRetentionSettings

      public boolean hasCampaignRetentionSettings()
       Retention goal campaign settings.
      .google.ads.googleads.v22.common.CampaignGoalSettings.CampaignRetentionGoalSettings campaign_retention_settings = 5;
      Specified by:
      hasCampaignRetentionSettings in interface CampaignGoalConfigOrBuilder
      Returns:
      Whether the campaignRetentionSettings field is set.

    • getCampaignRetentionSettings

      public CampaignGoalSettings.CampaignRetentionGoalSettings getCampaignRetentionSettings()
       Retention goal campaign settings.
      .google.ads.googleads.v22.common.CampaignGoalSettings.CampaignRetentionGoalSettings campaign_retention_settings = 5;
      Specified by:
      getCampaignRetentionSettings in interface CampaignGoalConfigOrBuilder
      Returns:
      The campaignRetentionSettings.

    • getCampaignRetentionSettingsOrBuilder

      public CampaignGoalSettings.CampaignRetentionGoalSettingsOrBuilder getCampaignRetentionSettingsOrBuilder()
       Retention goal campaign settings.
      .google.ads.googleads.v22.common.CampaignGoalSettings.CampaignRetentionGoalSettings campaign_retention_settings = 5;
      Specified by:
      getCampaignRetentionSettingsOrBuilder in interface CampaignGoalConfigOrBuilder

    • 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 CampaignGoalConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CampaignGoalConfig.Builder newBuilder()

    • newBuilder

      public static CampaignGoalConfig.Builder newBuilder(CampaignGoalConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected CampaignGoalConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static CampaignGoalConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CampaignGoalConfig> 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 CampaignGoalConfig 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