Class CampaignCriterionSimulation

  • All Implemented Interfaces:
    CampaignCriterionSimulationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

    public final class CampaignCriterionSimulation
    extends com.google.protobuf.GeneratedMessageV3
    implements CampaignCriterionSimulationOrBuilder
     A campaign criterion simulation. Supported combinations of advertising
     channel type, criterion ids, simulation type and simulation modification
     method is detailed below respectively.
     1. SEARCH - 30000,30001,30002 - BID_MODIFIER - UNIFORM
     2. DISPLAY - 30001 - BID_MODIFIER - UNIFORM
     
    Protobuf type google.ads.googleads.v10.resources.CampaignCriterionSimulation
    See Also:
    Serialized Form
    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CAMPAIGN_ID_FIELD_NUMBER

        public static final int CAMPAIGN_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CRITERION_ID_FIELD_NUMBER

        public static final int CRITERION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
      • MODIFICATION_METHOD_FIELD_NUMBER

        public static final int MODIFICATION_METHOD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • START_DATE_FIELD_NUMBER

        public static final int START_DATE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • BID_MODIFIER_POINT_LIST_FIELD_NUMBER

        public static final int BID_MODIFIER_POINT_LIST_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()
         Output only. The resource name of the campaign criterion simulation.
         Campaign criterion simulation resource names have the form:
         `customers/{customer_id}/campaignCriterionSimulations/{campaign_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 CampaignCriterionSimulationOrBuilder
        Returns:
        The resourceName.
      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Output only. The resource name of the campaign criterion simulation.
         Campaign criterion simulation resource names have the form:
         `customers/{customer_id}/campaignCriterionSimulations/{campaign_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 CampaignCriterionSimulationOrBuilder
        Returns:
        The bytes for resourceName.
      • hasCampaignId

        public boolean hasCampaignId()
         Output only. Campaign ID of the simulation.
         
        optional int64 campaign_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCampaignId in interface CampaignCriterionSimulationOrBuilder
        Returns:
        Whether the campaignId field is set.
      • getCampaignId

        public long getCampaignId()
         Output only. Campaign ID of the simulation.
         
        optional int64 campaign_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCampaignId in interface CampaignCriterionSimulationOrBuilder
        Returns:
        The campaignId.
      • 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 CampaignCriterionSimulationOrBuilder
        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 CampaignCriterionSimulationOrBuilder
        Returns:
        The criterionId.
      • getTypeValue

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

        public int getModificationMethodValue()
         Output only. How the simulation modifies the field.
         
        .google.ads.googleads.v10.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getModificationMethodValue in interface CampaignCriterionSimulationOrBuilder
        Returns:
        The enum numeric value on the wire for modificationMethod.
      • 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 CampaignCriterionSimulationOrBuilder
        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 CampaignCriterionSimulationOrBuilder
        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 CampaignCriterionSimulationOrBuilder
        Returns:
        The bytes for startDate.
      • 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 CampaignCriterionSimulationOrBuilder
        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 CampaignCriterionSimulationOrBuilder
        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 CampaignCriterionSimulationOrBuilder
        Returns:
        The bytes for endDate.
      • hasBidModifierPointList

        public boolean hasBidModifierPointList()
         Output only. Simulation points if the simulation type is BID_MODIFIER.
         
        .google.ads.googleads.v10.common.BidModifierSimulationPointList bid_modifier_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasBidModifierPointList in interface CampaignCriterionSimulationOrBuilder
        Returns:
        Whether the bidModifierPointList field is set.
      • 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 CampaignCriterionSimulation parseFrom​(java.nio.ByteBuffer data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CampaignCriterionSimulation parseFrom​(java.nio.ByteBuffer data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

        public static CampaignCriterionSimulation parseFrom​(java.io.InputStream input)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

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

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

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

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

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

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

        protected CampaignCriterionSimulation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<CampaignCriterionSimulation> 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 CampaignCriterionSimulation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder