Class AdGroupCriterionSimulation.Builder

  • All Implemented Interfaces:
    AdGroupCriterionSimulationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    AdGroupCriterionSimulation

    public static final class AdGroupCriterionSimulation.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<AdGroupCriterionSimulation.Builder>
    implements AdGroupCriterionSimulationOrBuilder
     An ad group criterion simulation. Supported combinations of advertising
     channel type, criterion type, simulation type, and simulation modification
     method are detailed below respectively. Hotel AdGroupCriterion simulation
     operations starting in V5.
    
     1. DISPLAY - KEYWORD - CPC_BID - UNIFORM
     2. SEARCH - KEYWORD - CPC_BID - UNIFORM
     3. SHOPPING - LISTING_GROUP - CPC_BID - UNIFORM
     4. HOTEL - LISTING_GROUP - CPC_BID - UNIFORM
     5. HOTEL - LISTING_GROUP - PERCENT_CPC_BID - UNIFORM
     
    Protobuf type google.ads.googleads.v14.resources.AdGroupCriterionSimulation
    • Method Detail

      • 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.Builder<AdGroupCriterionSimulation.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AdGroupCriterionSimulation.Builder>
      • getDefaultInstanceForType

        public AdGroupCriterionSimulation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public AdGroupCriterionSimulation build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public AdGroupCriterionSimulation buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • setRepeatedField

        public AdGroupCriterionSimulation.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                   int index,
                                                                   java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AdGroupCriterionSimulation.Builder>
      • addRepeatedField

        public AdGroupCriterionSimulation.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                   java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AdGroupCriterionSimulation.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AdGroupCriterionSimulation.Builder>
      • mergeFrom

        public AdGroupCriterionSimulation.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AdGroupCriterionSimulation.Builder>
        Throws:
        java.io.IOException
      • getResourceName

        public java.lang.String getResourceName()
         Output only. The resource name of the ad group criterion simulation.
         Ad group criterion simulation resource names have the form:
        
         `customers/{customer_id}/adGroupCriterionSimulations/{ad_group_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        The resourceName.
      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Output only. The resource name of the ad group criterion simulation.
         Ad group criterion simulation resource names have the form:
        
         `customers/{customer_id}/adGroupCriterionSimulations/{ad_group_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        The bytes for resourceName.
      • setResourceName

        public AdGroupCriterionSimulation.Builder setResourceName​(java.lang.String value)
         Output only. The resource name of the ad group criterion simulation.
         Ad group criterion simulation resource names have the form:
        
         `customers/{customer_id}/adGroupCriterionSimulations/{ad_group_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The resourceName to set.
        Returns:
        This builder for chaining.
      • clearResourceName

        public AdGroupCriterionSimulation.Builder clearResourceName()
         Output only. The resource name of the ad group criterion simulation.
         Ad group criterion simulation resource names have the form:
        
         `customers/{customer_id}/adGroupCriterionSimulations/{ad_group_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.
      • setResourceNameBytes

        public AdGroupCriterionSimulation.Builder setResourceNameBytes​(com.google.protobuf.ByteString value)
         Output only. The resource name of the ad group criterion simulation.
         Ad group criterion simulation resource names have the form:
        
         `customers/{customer_id}/adGroupCriterionSimulations/{ad_group_id}~{criterion_id}~{type}~{modification_method}~{start_date}~{end_date}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for resourceName to set.
        Returns:
        This builder for chaining.
      • hasAdGroupId

        public boolean hasAdGroupId()
         Output only. AdGroup ID of the simulation.
         
        optional int64 ad_group_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasAdGroupId in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        Whether the adGroupId field is set.
      • getAdGroupId

        public long getAdGroupId()
         Output only. AdGroup ID of the simulation.
         
        optional int64 ad_group_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAdGroupId in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        The adGroupId.
      • setAdGroupId

        public AdGroupCriterionSimulation.Builder setAdGroupId​(long value)
         Output only. AdGroup ID of the simulation.
         
        optional int64 ad_group_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The adGroupId to set.
        Returns:
        This builder for chaining.
      • clearAdGroupId

        public AdGroupCriterionSimulation.Builder clearAdGroupId()
         Output only. AdGroup ID of the simulation.
         
        optional int64 ad_group_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • hasCriterionId

        public boolean hasCriterionId()
         Output only. Criterion ID of the simulation.
         
        optional int64 criterion_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCriterionId in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        Whether the criterionId field is set.
      • getCriterionId

        public long getCriterionId()
         Output only. Criterion ID of the simulation.
         
        optional int64 criterion_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCriterionId in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        The criterionId.
      • setCriterionId

        public AdGroupCriterionSimulation.Builder setCriterionId​(long value)
         Output only. Criterion ID of the simulation.
         
        optional int64 criterion_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The criterionId to set.
        Returns:
        This builder for chaining.
      • clearCriterionId

        public AdGroupCriterionSimulation.Builder clearCriterionId()
         Output only. Criterion ID of the simulation.
         
        optional int64 criterion_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • getTypeValue

        public int getTypeValue()
         Output only. The field that the simulation modifies.
         
        .google.ads.googleads.v14.enums.SimulationTypeEnum.SimulationType type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTypeValue in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        The enum numeric value on the wire for type.
      • setTypeValue

        public AdGroupCriterionSimulation.Builder setTypeValue​(int value)
         Output only. The field that the simulation modifies.
         
        .google.ads.googleads.v14.enums.SimulationTypeEnum.SimulationType type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for type to set.
        Returns:
        This builder for chaining.
      • setType

        public AdGroupCriterionSimulation.Builder setType​(SimulationTypeEnum.SimulationType value)
         Output only. The field that the simulation modifies.
         
        .google.ads.googleads.v14.enums.SimulationTypeEnum.SimulationType type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The type to set.
        Returns:
        This builder for chaining.
      • clearType

        public AdGroupCriterionSimulation.Builder clearType()
         Output only. The field that the simulation modifies.
         
        .google.ads.googleads.v14.enums.SimulationTypeEnum.SimulationType type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • getModificationMethodValue

        public int getModificationMethodValue()
         Output only. How the simulation modifies the field.
         
        .google.ads.googleads.v14.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getModificationMethodValue in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        The enum numeric value on the wire for modificationMethod.
      • setModificationMethodValue

        public AdGroupCriterionSimulation.Builder setModificationMethodValue​(int value)
         Output only. How the simulation modifies the field.
         
        .google.ads.googleads.v14.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for modificationMethod to set.
        Returns:
        This builder for chaining.
      • clearModificationMethod

        public AdGroupCriterionSimulation.Builder clearModificationMethod()
         Output only. How the simulation modifies the field.
         
        .google.ads.googleads.v14.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • hasStartDate

        public boolean hasStartDate()
         Output only. First day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string start_date = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStartDate in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        Whether the startDate field is set.
      • getStartDate

        public java.lang.String getStartDate()
         Output only. First day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string start_date = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartDate in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        The startDate.
      • getStartDateBytes

        public com.google.protobuf.ByteString getStartDateBytes()
         Output only. First day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string start_date = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartDateBytes in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        The bytes for startDate.
      • setStartDate

        public AdGroupCriterionSimulation.Builder setStartDate​(java.lang.String value)
         Output only. First day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string start_date = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The startDate to set.
        Returns:
        This builder for chaining.
      • clearStartDate

        public AdGroupCriterionSimulation.Builder clearStartDate()
         Output only. First day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string start_date = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setStartDateBytes

        public AdGroupCriterionSimulation.Builder setStartDateBytes​(com.google.protobuf.ByteString value)
         Output only. First day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string start_date = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for startDate to set.
        Returns:
        This builder for chaining.
      • hasEndDate

        public boolean hasEndDate()
         Output only. Last day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string end_date = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEndDate in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        Whether the endDate field is set.
      • getEndDate

        public java.lang.String getEndDate()
         Output only. Last day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string end_date = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndDate in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        The endDate.
      • getEndDateBytes

        public com.google.protobuf.ByteString getEndDateBytes()
         Output only. Last day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string end_date = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndDateBytes in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        The bytes for endDate.
      • setEndDate

        public AdGroupCriterionSimulation.Builder setEndDate​(java.lang.String value)
         Output only. Last day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string end_date = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The endDate to set.
        Returns:
        This builder for chaining.
      • clearEndDate

        public AdGroupCriterionSimulation.Builder clearEndDate()
         Output only. Last day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string end_date = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setEndDateBytes

        public AdGroupCriterionSimulation.Builder setEndDateBytes​(com.google.protobuf.ByteString value)
         Output only. Last day on which the simulation is based, in YYYY-MM-DD
         format.
         
        optional string end_date = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for endDate to set.
        Returns:
        This builder for chaining.
      • hasCpcBidPointList

        public boolean hasCpcBidPointList()
         Output only. Simulation points if the simulation type is CPC_BID.
         
        .google.ads.googleads.v14.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCpcBidPointList in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        Whether the cpcBidPointList field is set.
      • setCpcBidPointList

        public AdGroupCriterionSimulation.Builder setCpcBidPointList​(CpcBidSimulationPointList value)
         Output only. Simulation points if the simulation type is CPC_BID.
         
        .google.ads.googleads.v14.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeCpcBidPointList

        public AdGroupCriterionSimulation.Builder mergeCpcBidPointList​(CpcBidSimulationPointList value)
         Output only. Simulation points if the simulation type is CPC_BID.
         
        .google.ads.googleads.v14.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearCpcBidPointList

        public AdGroupCriterionSimulation.Builder clearCpcBidPointList()
         Output only. Simulation points if the simulation type is CPC_BID.
         
        .google.ads.googleads.v14.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getCpcBidPointListBuilder

        public CpcBidSimulationPointList.Builder getCpcBidPointListBuilder()
         Output only. Simulation points if the simulation type is CPC_BID.
         
        .google.ads.googleads.v14.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • hasPercentCpcBidPointList

        public boolean hasPercentCpcBidPointList()
         Output only. Simulation points if the simulation type is PERCENT_CPC_BID.
         
        .google.ads.googleads.v14.common.PercentCpcBidSimulationPointList percent_cpc_bid_point_list = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasPercentCpcBidPointList in interface AdGroupCriterionSimulationOrBuilder
        Returns:
        Whether the percentCpcBidPointList field is set.
      • setPercentCpcBidPointList

        public AdGroupCriterionSimulation.Builder setPercentCpcBidPointList​(PercentCpcBidSimulationPointList value)
         Output only. Simulation points if the simulation type is PERCENT_CPC_BID.
         
        .google.ads.googleads.v14.common.PercentCpcBidSimulationPointList percent_cpc_bid_point_list = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setPercentCpcBidPointList

        public AdGroupCriterionSimulation.Builder setPercentCpcBidPointList​(PercentCpcBidSimulationPointList.Builder builderForValue)
         Output only. Simulation points if the simulation type is PERCENT_CPC_BID.
         
        .google.ads.googleads.v14.common.PercentCpcBidSimulationPointList percent_cpc_bid_point_list = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergePercentCpcBidPointList

        public AdGroupCriterionSimulation.Builder mergePercentCpcBidPointList​(PercentCpcBidSimulationPointList value)
         Output only. Simulation points if the simulation type is PERCENT_CPC_BID.
         
        .google.ads.googleads.v14.common.PercentCpcBidSimulationPointList percent_cpc_bid_point_list = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearPercentCpcBidPointList

        public AdGroupCriterionSimulation.Builder clearPercentCpcBidPointList()
         Output only. Simulation points if the simulation type is PERCENT_CPC_BID.
         
        .google.ads.googleads.v14.common.PercentCpcBidSimulationPointList percent_cpc_bid_point_list = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getPercentCpcBidPointListBuilder

        public PercentCpcBidSimulationPointList.Builder getPercentCpcBidPointListBuilder()
         Output only. Simulation points if the simulation type is PERCENT_CPC_BID.
         
        .google.ads.googleads.v14.common.PercentCpcBidSimulationPointList percent_cpc_bid_point_list = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setUnknownFields

        public final AdGroupCriterionSimulation.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AdGroupCriterionSimulation.Builder>
      • mergeUnknownFields

        public final AdGroupCriterionSimulation.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AdGroupCriterionSimulation.Builder>