Class CampaignDraft

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.v21.resources.CampaignDraft
All Implemented Interfaces:
CampaignDraftOrBuilder, 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 CampaignDraft extends com.google.protobuf.GeneratedMessageV3 implements CampaignDraftOrBuilder
 A campaign draft.
 
Protobuf type google.ads.googleads.v21.resources.CampaignDraft
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    A campaign draft.

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

    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
     
    Immutable.
    com.google.protobuf.ByteString
    Immutable.
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    Output only.
    com.google.protobuf.ByteString
    Output only.
    long
    Output only.
    boolean
    Output only.
    Output only.
    com.google.protobuf.ByteString
    Output only.
    The name of the campaign draft.
    com.google.protobuf.ByteString
    The name of the campaign draft.
    com.google.protobuf.Parser<CampaignDraft>
     
    Immutable.
    com.google.protobuf.ByteString
    Immutable.
    int
     
    Output only.
    int
    Output only.
    boolean
    Immutable.
    boolean
    Output only.
    boolean
    Output only.
    boolean
    Output only.
    int
     
    boolean
    Output only.
    boolean
    The name of the campaign draft.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CampaignDraft>
     
     
    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:
    • DRAFT_ID_FIELD_NUMBER

      public static final int DRAFT_ID_FIELD_NUMBER
      See Also:
    • BASE_CAMPAIGN_FIELD_NUMBER

      public static final int BASE_CAMPAIGN_FIELD_NUMBER
      See Also:
    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • DRAFT_CAMPAIGN_FIELD_NUMBER

      public static final int DRAFT_CAMPAIGN_FIELD_NUMBER
      See Also:
    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:
    • HAS_EXPERIMENT_RUNNING_FIELD_NUMBER

      public static final int HAS_EXPERIMENT_RUNNING_FIELD_NUMBER
      See Also:
    • LONG_RUNNING_OPERATION_FIELD_NUMBER

      public static final int LONG_RUNNING_OPERATION_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
    • getResourceName

      public String getResourceName()
       Immutable. The resource name of the campaign draft.
       Campaign draft resource names have the form:
      
       `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}`
       
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceName in interface CampaignDraftOrBuilder
      Returns:
      The resourceName.
    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       Immutable. The resource name of the campaign draft.
       Campaign draft resource names have the form:
      
       `customers/{customer_id}/campaignDrafts/{base_campaign_id}~{draft_id}`
       
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface CampaignDraftOrBuilder
      Returns:
      The bytes for resourceName.
    • hasDraftId

      public boolean hasDraftId()
       Output only. The ID of the draft.
      
       This field is read-only.
       
      optional int64 draft_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasDraftId in interface CampaignDraftOrBuilder
      Returns:
      Whether the draftId field is set.
    • getDraftId

      public long getDraftId()
       Output only. The ID of the draft.
      
       This field is read-only.
       
      optional int64 draft_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDraftId in interface CampaignDraftOrBuilder
      Returns:
      The draftId.
    • hasBaseCampaign

      public boolean hasBaseCampaign()
       Immutable. The base campaign to which the draft belongs.
       
      optional string base_campaign = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      hasBaseCampaign in interface CampaignDraftOrBuilder
      Returns:
      Whether the baseCampaign field is set.
    • getBaseCampaign

      public String getBaseCampaign()
       Immutable. The base campaign to which the draft belongs.
       
      optional string base_campaign = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getBaseCampaign in interface CampaignDraftOrBuilder
      Returns:
      The baseCampaign.
    • getBaseCampaignBytes

      public com.google.protobuf.ByteString getBaseCampaignBytes()
       Immutable. The base campaign to which the draft belongs.
       
      optional string base_campaign = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getBaseCampaignBytes in interface CampaignDraftOrBuilder
      Returns:
      The bytes for baseCampaign.
    • hasName

      public boolean hasName()
       The name of the campaign draft.
      
       This field is required and should not be empty when creating new
       campaign drafts.
      
       It must not contain any null (code point 0x0), NL line feed
       (code point 0xA) or carriage return (code point 0xD) characters.
       
      optional string name = 11;
      Specified by:
      hasName in interface CampaignDraftOrBuilder
      Returns:
      Whether the name field is set.
    • getName

      public String getName()
       The name of the campaign draft.
      
       This field is required and should not be empty when creating new
       campaign drafts.
      
       It must not contain any null (code point 0x0), NL line feed
       (code point 0xA) or carriage return (code point 0xD) characters.
       
      optional string name = 11;
      Specified by:
      getName in interface CampaignDraftOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name of the campaign draft.
      
       This field is required and should not be empty when creating new
       campaign drafts.
      
       It must not contain any null (code point 0x0), NL line feed
       (code point 0xA) or carriage return (code point 0xD) characters.
       
      optional string name = 11;
      Specified by:
      getNameBytes in interface CampaignDraftOrBuilder
      Returns:
      The bytes for name.
    • hasDraftCampaign

      public boolean hasDraftCampaign()
       Output only. Resource name of the Campaign that results from overlaying the
       draft changes onto the base campaign.
      
       This field is read-only.
       
      optional string draft_campaign = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      hasDraftCampaign in interface CampaignDraftOrBuilder
      Returns:
      Whether the draftCampaign field is set.
    • getDraftCampaign

      public String getDraftCampaign()
       Output only. Resource name of the Campaign that results from overlaying the
       draft changes onto the base campaign.
      
       This field is read-only.
       
      optional string draft_campaign = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getDraftCampaign in interface CampaignDraftOrBuilder
      Returns:
      The draftCampaign.
    • getDraftCampaignBytes

      public com.google.protobuf.ByteString getDraftCampaignBytes()
       Output only. Resource name of the Campaign that results from overlaying the
       draft changes onto the base campaign.
      
       This field is read-only.
       
      optional string draft_campaign = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getDraftCampaignBytes in interface CampaignDraftOrBuilder
      Returns:
      The bytes for draftCampaign.
    • getStatusValue

      public int getStatusValue()
       Output only. The status of the campaign draft. This field is read-only.
      
       When a new campaign draft is added, the status defaults to PROPOSED.
       
      .google.ads.googleads.v21.enums.CampaignDraftStatusEnum.CampaignDraftStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStatusValue in interface CampaignDraftOrBuilder
      Returns:
      The enum numeric value on the wire for status.
    • getStatus

       Output only. The status of the campaign draft. This field is read-only.
      
       When a new campaign draft is added, the status defaults to PROPOSED.
       
      .google.ads.googleads.v21.enums.CampaignDraftStatusEnum.CampaignDraftStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStatus in interface CampaignDraftOrBuilder
      Returns:
      The status.
    • hasHasExperimentRunning

      public boolean hasHasExperimentRunning()
       Output only. Whether there is an experiment based on this draft currently
       serving.
       
      optional bool has_experiment_running = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasHasExperimentRunning in interface CampaignDraftOrBuilder
      Returns:
      Whether the hasExperimentRunning field is set.
    • getHasExperimentRunning

      public boolean getHasExperimentRunning()
       Output only. Whether there is an experiment based on this draft currently
       serving.
       
      optional bool has_experiment_running = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getHasExperimentRunning in interface CampaignDraftOrBuilder
      Returns:
      The hasExperimentRunning.
    • hasLongRunningOperation

      public boolean hasLongRunningOperation()
       Output only. The resource name of the long-running operation that can be
       used to poll for completion of draft promotion. This is only set if the
       draft promotion is in progress or finished.
       
      optional string long_running_operation = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasLongRunningOperation in interface CampaignDraftOrBuilder
      Returns:
      Whether the longRunningOperation field is set.
    • getLongRunningOperation

      public String getLongRunningOperation()
       Output only. The resource name of the long-running operation that can be
       used to poll for completion of draft promotion. This is only set if the
       draft promotion is in progress or finished.
       
      optional string long_running_operation = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLongRunningOperation in interface CampaignDraftOrBuilder
      Returns:
      The longRunningOperation.
    • getLongRunningOperationBytes

      public com.google.protobuf.ByteString getLongRunningOperationBytes()
       Output only. The resource name of the long-running operation that can be
       used to poll for completion of draft promotion. This is only set if the
       draft promotion is in progress or finished.
       
      optional string long_running_operation = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLongRunningOperationBytes in interface CampaignDraftOrBuilder
      Returns:
      The bytes for longRunningOperation.
    • 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 CampaignDraft parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static CampaignDraft parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static CampaignDraft parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static CampaignDraft.Builder newBuilder()
    • newBuilder

      public static CampaignDraft.Builder newBuilder(CampaignDraft prototype)
    • toBuilder

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

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

      public static CampaignDraft getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<CampaignDraft> parser()
    • getParserForType

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