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

Class CampaignSimulation

  • All Implemented Interfaces:
    CampaignSimulationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class CampaignSimulation
extends com.google.protobuf.GeneratedMessageV3
implements CampaignSimulationOrBuilder
     A campaign simulation. Supported combinations of advertising
 channel type, simulation type and simulation modification
 method is detailed below respectively.
 SEARCH - CPC_BID - UNIFORM
 SEARCH - CPC_BID - SCALING
 SEARCH - TARGET_CPA - UNIFORM
 SEARCH - TARGET_CPA - SCALING
 SEARCH - TARGET_ROAS - UNIFORM
 SEARCH - TARGET_IMPRESSION_SHARE - UNIFORM
 SEARCH - BUDGET - UNIFORM
 SHOPPING - BUDGET - UNIFORM
 SHOPPING - TARGET_ROAS - UNIFORM
 MULTIPLE - TARGET_CPA - UNIFORM
 OWNED_AND_OPERATED - TARGET_CPA - DEFAULT
 DISPLAY - TARGET_CPA - UNIFORM
    Protobuf type google.ads.googleads.v10.resources.CampaignSimulation
    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

      • 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

      • CPC_BID_POINT_LIST_FIELD_NUMBER

        public static final int CPC_BID_POINT_LIST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_CPA_POINT_LIST_FIELD_NUMBER

        public static final int TARGET_CPA_POINT_LIST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_ROAS_POINT_LIST_FIELD_NUMBER

        public static final int TARGET_ROAS_POINT_LIST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_IMPRESSION_SHARE_POINT_LIST_FIELD_NUMBER

        public static final int TARGET_IMPRESSION_SHARE_POINT_LIST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BUDGET_POINT_LIST_FIELD_NUMBER

        public static final int BUDGET_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 simulation.
 Campaign simulation resource names have the form:
 `customers/{customer_id}/campaignSimulations/{campaign_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 CampaignSimulationOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

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

      • getCampaignId

        public long getCampaignId()
         Output only. Campaign id of the simulation.
        int64 campaign_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCampaignId in interface CampaignSimulationOrBuilder
        Returns:
        The campaignId.

      • getTypeValue

        public int getTypeValue()
         Output only. The field that the simulation modifies.
        .google.ads.googleads.v10.enums.SimulationTypeEnum.SimulationType type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTypeValue in interface CampaignSimulationOrBuilder
        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 = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getModificationMethodValue in interface CampaignSimulationOrBuilder
        Returns:
        The enum numeric value on the wire for modificationMethod.

      • getStartDate

        public java.lang.String getStartDate()
         Output only. First day on which the simulation is based, in YYYY-MM-DD format.
        string start_date = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartDate in interface CampaignSimulationOrBuilder
        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.
        string start_date = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartDateBytes in interface CampaignSimulationOrBuilder
        Returns:
        The bytes for startDate.

      • getEndDate

        public java.lang.String getEndDate()
         Output only. Last day on which the simulation is based, in YYYY-MM-DD format
        string end_date = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndDate in interface CampaignSimulationOrBuilder
        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
        string end_date = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndDateBytes in interface CampaignSimulationOrBuilder
        Returns:
        The bytes for endDate.

      • hasCpcBidPointList

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

      • getCpcBidPointList

        public CpcBidSimulationPointList getCpcBidPointList()
         Output only. Simulation points if the simulation type is CPC_BID.
        .google.ads.googleads.v10.common.CpcBidSimulationPointList cpc_bid_point_list = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCpcBidPointList in interface CampaignSimulationOrBuilder
        Returns:
        The cpcBidPointList.

      • hasTargetCpaPointList

        public boolean hasTargetCpaPointList()
         Output only. Simulation points if the simulation type is TARGET_CPA.
        .google.ads.googleads.v10.common.TargetCpaSimulationPointList target_cpa_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasTargetCpaPointList in interface CampaignSimulationOrBuilder
        Returns:
        Whether the targetCpaPointList field is set.

      • getTargetCpaPointList

        public TargetCpaSimulationPointList getTargetCpaPointList()
         Output only. Simulation points if the simulation type is TARGET_CPA.
        .google.ads.googleads.v10.common.TargetCpaSimulationPointList target_cpa_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTargetCpaPointList in interface CampaignSimulationOrBuilder
        Returns:
        The targetCpaPointList.

      • hasTargetRoasPointList

        public boolean hasTargetRoasPointList()
         Output only. Simulation points if the simulation type is TARGET_ROAS.
        .google.ads.googleads.v10.common.TargetRoasSimulationPointList target_roas_point_list = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasTargetRoasPointList in interface CampaignSimulationOrBuilder
        Returns:
        Whether the targetRoasPointList field is set.

      • getTargetRoasPointList

        public TargetRoasSimulationPointList getTargetRoasPointList()
         Output only. Simulation points if the simulation type is TARGET_ROAS.
        .google.ads.googleads.v10.common.TargetRoasSimulationPointList target_roas_point_list = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTargetRoasPointList in interface CampaignSimulationOrBuilder
        Returns:
        The targetRoasPointList.

      • hasTargetImpressionSharePointList

        public boolean hasTargetImpressionSharePointList()
         Output only. Simulation points if the simulation type is TARGET_IMPRESSION_SHARE.
        .google.ads.googleads.v10.common.TargetImpressionShareSimulationPointList target_impression_share_point_list = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasTargetImpressionSharePointList in interface CampaignSimulationOrBuilder
        Returns:
        Whether the targetImpressionSharePointList field is set.

      • hasBudgetPointList

        public boolean hasBudgetPointList()
         Output only. Simulation points if the simulation type is BUDGET.
        .google.ads.googleads.v10.common.BudgetSimulationPointList budget_point_list = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasBudgetPointList in interface CampaignSimulationOrBuilder
        Returns:
        Whether the budgetPointList field is set.

      • getBudgetPointList

        public BudgetSimulationPointList getBudgetPointList()
         Output only. Simulation points if the simulation type is BUDGET.
        .google.ads.googleads.v10.common.BudgetSimulationPointList budget_point_list = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getBudgetPointList in interface CampaignSimulationOrBuilder
        Returns:
        The budgetPointList.

      • 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 CampaignSimulation parseFrom​(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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