Package com.google.ads.googleads.v18.resources

Interface CampaignDraftOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CampaignDraft, CampaignDraft.Builder
public interface CampaignDraftOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getResourceName

      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) = { ... }
      Returns:
      The resourceName.

    • getResourceNameBytes

      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) = { ... }
      Returns:
      The bytes for resourceName.

    • hasDraftId

      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];
      Returns:
      Whether the draftId field is set.

    • getDraftId

      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];
      Returns:
      The draftId.

    • hasBaseCampaign

      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) = { ... }
      Returns:
      Whether the baseCampaign field is set.

    • getBaseCampaign

      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) = { ... }
      Returns:
      The baseCampaign.

    • getBaseCampaignBytes

      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) = { ... }
      Returns:
      The bytes for baseCampaign.

    • hasName

      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;
      Returns:
      Whether the name field is set.

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • hasDraftCampaign

      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) = { ... }
      Returns:
      Whether the draftCampaign field is set.

    • getDraftCampaign

      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) = { ... }
      Returns:
      The draftCampaign.

    • getDraftCampaignBytes

      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) = { ... }
      Returns:
      The bytes for draftCampaign.

    • getStatusValue

      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.v18.enums.CampaignDraftStatusEnum.CampaignDraftStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      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.v18.enums.CampaignDraftStatusEnum.CampaignDraftStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The status.

    • hasHasExperimentRunning

      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];
      Returns:
      Whether the hasExperimentRunning field is set.

    • getHasExperimentRunning

      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];
      Returns:
      The hasExperimentRunning.

    • hasLongRunningOperation

      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];
      Returns:
      Whether the longRunningOperation field is set.

    • getLongRunningOperation

      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];
      Returns:
      The longRunningOperation.

    • getLongRunningOperationBytes

      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];
      Returns:
      The bytes for longRunningOperation.