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

Interface CampaignExperimentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CampaignExperiment, CampaignExperiment.Builder
    public interface CampaignExperimentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getResourceName

        java.lang.String getResourceName()
         Immutable. The resource name of the campaign experiment.
 Campaign experiment resource names have the form:
 `customers/{customer_id}/campaignExperiments/{campaign_experiment_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 experiment.
 Campaign experiment resource names have the form:
 `customers/{customer_id}/campaignExperiments/{campaign_experiment_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for resourceName.

      • hasId

        boolean hasId()
         Output only. The ID of the campaign experiment.
 This field is read-only.
        optional int64 id = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the id field is set.

      • getId

        long getId()
         Output only. The ID of the campaign experiment.
 This field is read-only.
        optional int64 id = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The id.

      • hasCampaignDraft

        boolean hasCampaignDraft()
         Immutable. The campaign draft with staged changes to the base campaign.
        optional string campaign_draft = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        Whether the campaignDraft field is set.

      • getCampaignDraft

        java.lang.String getCampaignDraft()
         Immutable. The campaign draft with staged changes to the base campaign.
        optional string campaign_draft = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        The campaignDraft.

      • getCampaignDraftBytes

        com.google.protobuf.ByteString getCampaignDraftBytes()
         Immutable. The campaign draft with staged changes to the base campaign.
        optional string campaign_draft = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for campaignDraft.

      • hasName

        boolean hasName()
         The name of the campaign experiment.
 This field is required when creating new campaign experiments
 and must not conflict with the name of another non-removed
 campaign experiment or campaign.
 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 = 15;
        Returns:
        Whether the name field is set.

      • getName

        java.lang.String getName()
         The name of the campaign experiment.
 This field is required when creating new campaign experiments
 and must not conflict with the name of another non-removed
 campaign experiment or campaign.
 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 = 15;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The name of the campaign experiment.
 This field is required when creating new campaign experiments
 and must not conflict with the name of another non-removed
 campaign experiment or campaign.
 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 = 15;
        Returns:
        The bytes for name.

      • hasDescription

        boolean hasDescription()
         The description of the experiment.
        optional string description = 16;
        Returns:
        Whether the description field is set.

      • getDescription

        java.lang.String getDescription()
         The description of the experiment.
        optional string description = 16;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         The description of the experiment.
        optional string description = 16;
        Returns:
        The bytes for description.

      • hasTrafficSplitPercent

        boolean hasTrafficSplitPercent()
         Immutable. Share of traffic directed to experiment as a percent (must be between 1 and
 99 inclusive. Base campaign receives the remainder of the traffic
 (100 - traffic_split_percent). Required for create.
        optional int64 traffic_split_percent = 17 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        Whether the trafficSplitPercent field is set.

      • getTrafficSplitPercent

        long getTrafficSplitPercent()
         Immutable. Share of traffic directed to experiment as a percent (must be between 1 and
 99 inclusive. Base campaign receives the remainder of the traffic
 (100 - traffic_split_percent). Required for create.
        optional int64 traffic_split_percent = 17 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The trafficSplitPercent.

      • getTrafficSplitTypeValue

        int getTrafficSplitTypeValue()
         Immutable. Determines the behavior of the traffic split.
        .google.ads.googleads.v10.enums.CampaignExperimentTrafficSplitTypeEnum.CampaignExperimentTrafficSplitType traffic_split_type = 7 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The enum numeric value on the wire for trafficSplitType.

      • getTrafficSplitType

        CampaignExperimentTrafficSplitTypeEnum.CampaignExperimentTrafficSplitType getTrafficSplitType()
         Immutable. Determines the behavior of the traffic split.
        .google.ads.googleads.v10.enums.CampaignExperimentTrafficSplitTypeEnum.CampaignExperimentTrafficSplitType traffic_split_type = 7 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The trafficSplitType.

      • hasExperimentCampaign

        boolean hasExperimentCampaign()
         Output only. The experiment campaign, as opposed to the base campaign.
        optional string experiment_campaign = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        Whether the experimentCampaign field is set.

      • getExperimentCampaign

        java.lang.String getExperimentCampaign()
         Output only. The experiment campaign, as opposed to the base campaign.
        optional string experiment_campaign = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The experimentCampaign.

      • getExperimentCampaignBytes

        com.google.protobuf.ByteString getExperimentCampaignBytes()
         Output only. The experiment campaign, as opposed to the base campaign.
        optional string experiment_campaign = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for experimentCampaign.

      • getStatusValue

        int getStatusValue()
         Output only. The status of the campaign experiment. This field is read-only.
        .google.ads.googleads.v10.enums.CampaignExperimentStatusEnum.CampaignExperimentStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        CampaignExperimentStatusEnum.CampaignExperimentStatus getStatus()
         Output only. The status of the campaign experiment. This field is read-only.
        .google.ads.googleads.v10.enums.CampaignExperimentStatusEnum.CampaignExperimentStatus status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The status.

      • hasLongRunningOperation

        boolean hasLongRunningOperation()
         Output only. The resource name of the long-running operation that can be used to poll
 for completion of experiment create or promote. The most recent long
 running operation is returned.
        optional string long_running_operation = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the longRunningOperation field is set.

      • getLongRunningOperation

        java.lang.String getLongRunningOperation()
         Output only. The resource name of the long-running operation that can be used to poll
 for completion of experiment create or promote. The most recent long
 running operation is returned.
        optional string long_running_operation = 19 [(.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 experiment create or promote. The most recent long
 running operation is returned.
        optional string long_running_operation = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for longRunningOperation.

      • hasStartDate

        boolean hasStartDate()
         Date when the campaign experiment starts. By default, the experiment starts
 now or on the campaign's start date, whichever is later. If this field is
 set, then the experiment starts at the beginning of the specified date in
 the customer's time zone. Cannot be changed once the experiment starts.
 Format: YYYY-MM-DD
 Example: 2019-03-14
        optional string start_date = 20;
        Returns:
        Whether the startDate field is set.

      • getStartDate

        java.lang.String getStartDate()
         Date when the campaign experiment starts. By default, the experiment starts
 now or on the campaign's start date, whichever is later. If this field is
 set, then the experiment starts at the beginning of the specified date in
 the customer's time zone. Cannot be changed once the experiment starts.
 Format: YYYY-MM-DD
 Example: 2019-03-14
        optional string start_date = 20;
        Returns:
        The startDate.

      • getStartDateBytes

        com.google.protobuf.ByteString getStartDateBytes()
         Date when the campaign experiment starts. By default, the experiment starts
 now or on the campaign's start date, whichever is later. If this field is
 set, then the experiment starts at the beginning of the specified date in
 the customer's time zone. Cannot be changed once the experiment starts.
 Format: YYYY-MM-DD
 Example: 2019-03-14
        optional string start_date = 20;
        Returns:
        The bytes for startDate.

      • hasEndDate

        boolean hasEndDate()
         The last day of the campaign experiment. By default, the experiment ends on
 the campaign's end date. If this field is set, then the experiment ends at
 the end of the specified date in the customer's time zone.
 Format: YYYY-MM-DD
 Example: 2019-04-18
        optional string end_date = 21;
        Returns:
        Whether the endDate field is set.

      • getEndDate

        java.lang.String getEndDate()
         The last day of the campaign experiment. By default, the experiment ends on
 the campaign's end date. If this field is set, then the experiment ends at
 the end of the specified date in the customer's time zone.
 Format: YYYY-MM-DD
 Example: 2019-04-18
        optional string end_date = 21;
        Returns:
        The endDate.

      • getEndDateBytes

        com.google.protobuf.ByteString getEndDateBytes()
         The last day of the campaign experiment. By default, the experiment ends on
 the campaign's end date. If this field is set, then the experiment ends at
 the end of the specified date in the customer's time zone.
 Format: YYYY-MM-DD
 Example: 2019-04-18
        optional string end_date = 21;
        Returns:
        The bytes for endDate.