Package com.google.ads.googleads.v10.resources

Class CampaignDraft

  • All Implemented Interfaces:
    CampaignDraftOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class CampaignDraft
extends com.google.protobuf.GeneratedMessageV3
implements CampaignDraftOrBuilder
     A campaign draft.
    Protobuf type google.ads.googleads.v10.resources.CampaignDraft
    See Also:
    Serialized Form

    • Nested Class Summary

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

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BASE_CAMPAIGN_FIELD_NUMBER

        public static final int BASE_CAMPAIGN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DRAFT_CAMPAIGN_FIELD_NUMBER

        public static final int DRAFT_CAMPAIGN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HAS_EXPERIMENT_RUNNING_FIELD_NUMBER

        public static final int HAS_EXPERIMENT_RUNNING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LONG_RUNNING_OPERATION_FIELD_NUMBER

        public static final int LONG_RUNNING_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getResourceName

        public java.lang.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 java.lang.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 java.lang.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 java.lang.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.v10.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

        public CampaignDraftStatusEnum.CampaignDraftStatus 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.v10.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 java.lang.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.GeneratedMessageV3

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CampaignDraft parseFrom​(java.nio.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​(java.io.InputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static CampaignDraft parseFrom​(java.io.InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static CampaignDraft parseDelimitedFrom​(java.io.InputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static CampaignDraft parseDelimitedFrom​(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseFrom

        public static CampaignDraft parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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