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

Class AdGroupSimulation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.AdGroupSimulation
All Implemented Interfaces:
AdGroupSimulationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class AdGroupSimulation extends com.google.protobuf.GeneratedMessageV3 implements AdGroupSimulationOrBuilder
 An ad group simulation. Supported combinations of advertising
 channel type, simulation type and simulation modification method is
 detailed below respectively.

 1. SEARCH - CPC_BID - DEFAULT
 2. SEARCH - CPC_BID - UNIFORM
 3. SEARCH - TARGET_CPA - UNIFORM
 4. SEARCH - TARGET_ROAS - UNIFORM
 5. DISPLAY - CPC_BID - DEFAULT
 6. DISPLAY - CPC_BID - UNIFORM
 7. DISPLAY - TARGET_CPA - UNIFORM
Protobuf type google.ads.googleads.v18.resources.AdGroupSimulation
See Also:

  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • AD_GROUP_ID_FIELD_NUMBER

      public static final int AD_GROUP_ID_FIELD_NUMBER
      See Also:

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • MODIFICATION_METHOD_FIELD_NUMBER

      public static final int MODIFICATION_METHOD_FIELD_NUMBER
      See Also:

    • START_DATE_FIELD_NUMBER

      public static final int START_DATE_FIELD_NUMBER
      See Also:

    • END_DATE_FIELD_NUMBER

      public static final int END_DATE_FIELD_NUMBER
      See Also:

    • CPC_BID_POINT_LIST_FIELD_NUMBER

      public static final int CPC_BID_POINT_LIST_FIELD_NUMBER
      See Also:

    • CPV_BID_POINT_LIST_FIELD_NUMBER

      public static final int CPV_BID_POINT_LIST_FIELD_NUMBER
      See Also:

    • TARGET_CPA_POINT_LIST_FIELD_NUMBER

      public static final int TARGET_CPA_POINT_LIST_FIELD_NUMBER
      See Also:

    • TARGET_ROAS_POINT_LIST_FIELD_NUMBER

      public static final int TARGET_ROAS_POINT_LIST_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getPointListCase

      public AdGroupSimulation.PointListCase getPointListCase()
      Specified by:
      getPointListCase in interface AdGroupSimulationOrBuilder

    • getResourceName

      public String getResourceName()
       Output only. The resource name of the ad group simulation.
 Ad group simulation resource names have the form:

 `customers/{customer_id}/adGroupSimulations/{ad_group_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 AdGroupSimulationOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       Output only. The resource name of the ad group simulation.
 Ad group simulation resource names have the form:

 `customers/{customer_id}/adGroupSimulations/{ad_group_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 AdGroupSimulationOrBuilder
      Returns:
      The bytes for resourceName.

    • hasAdGroupId

      public boolean hasAdGroupId()
       Output only. Ad group id of the simulation.
      optional int64 ad_group_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasAdGroupId in interface AdGroupSimulationOrBuilder
      Returns:
      Whether the adGroupId field is set.

    • getAdGroupId

      public long getAdGroupId()
       Output only. Ad group id of the simulation.
      optional int64 ad_group_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAdGroupId in interface AdGroupSimulationOrBuilder
      Returns:
      The adGroupId.

    • getTypeValue

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

    • getType

      public SimulationTypeEnum.SimulationType getType()
       Output only. The field that the simulation modifies.
      .google.ads.googleads.v18.enums.SimulationTypeEnum.SimulationType type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getType in interface AdGroupSimulationOrBuilder
      Returns:
      The type.

    • getModificationMethodValue

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

    • getModificationMethod

      public SimulationModificationMethodEnum.SimulationModificationMethod getModificationMethod()
       Output only. How the simulation modifies the field.
      .google.ads.googleads.v18.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getModificationMethod in interface AdGroupSimulationOrBuilder
      Returns:
      The modificationMethod.

    • hasStartDate

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

    • getStartDate

      public String getStartDate()
       Output only. First day on which the simulation is based, in YYYY-MM-DD
 format.
      optional string start_date = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartDate in interface AdGroupSimulationOrBuilder
      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 = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartDateBytes in interface AdGroupSimulationOrBuilder
      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 = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasEndDate in interface AdGroupSimulationOrBuilder
      Returns:
      Whether the endDate field is set.

    • getEndDate

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

    • hasCpcBidPointList

      public boolean hasCpcBidPointList()
       Output only. Simulation points if the simulation type is CPC_BID.
      .google.ads.googleads.v18.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCpcBidPointList in interface AdGroupSimulationOrBuilder
      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.v18.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCpcBidPointList in interface AdGroupSimulationOrBuilder
      Returns:
      The cpcBidPointList.

    • getCpcBidPointListOrBuilder

      public CpcBidSimulationPointListOrBuilder getCpcBidPointListOrBuilder()
       Output only. Simulation points if the simulation type is CPC_BID.
      .google.ads.googleads.v18.common.CpcBidSimulationPointList cpc_bid_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCpcBidPointListOrBuilder in interface AdGroupSimulationOrBuilder

    • hasCpvBidPointList

      public boolean hasCpvBidPointList()
       Output only. Simulation points if the simulation type is CPV_BID.
      .google.ads.googleads.v18.common.CpvBidSimulationPointList cpv_bid_point_list = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCpvBidPointList in interface AdGroupSimulationOrBuilder
      Returns:
      Whether the cpvBidPointList field is set.

    • getCpvBidPointList

      public CpvBidSimulationPointList getCpvBidPointList()
       Output only. Simulation points if the simulation type is CPV_BID.
      .google.ads.googleads.v18.common.CpvBidSimulationPointList cpv_bid_point_list = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCpvBidPointList in interface AdGroupSimulationOrBuilder
      Returns:
      The cpvBidPointList.

    • getCpvBidPointListOrBuilder

      public CpvBidSimulationPointListOrBuilder getCpvBidPointListOrBuilder()
       Output only. Simulation points if the simulation type is CPV_BID.
      .google.ads.googleads.v18.common.CpvBidSimulationPointList cpv_bid_point_list = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCpvBidPointListOrBuilder in interface AdGroupSimulationOrBuilder

    • hasTargetCpaPointList

      public boolean hasTargetCpaPointList()
       Output only. Simulation points if the simulation type is TARGET_CPA.
      .google.ads.googleads.v18.common.TargetCpaSimulationPointList target_cpa_point_list = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasTargetCpaPointList in interface AdGroupSimulationOrBuilder
      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.v18.common.TargetCpaSimulationPointList target_cpa_point_list = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTargetCpaPointList in interface AdGroupSimulationOrBuilder
      Returns:
      The targetCpaPointList.

    • getTargetCpaPointListOrBuilder

      public TargetCpaSimulationPointListOrBuilder getTargetCpaPointListOrBuilder()
       Output only. Simulation points if the simulation type is TARGET_CPA.
      .google.ads.googleads.v18.common.TargetCpaSimulationPointList target_cpa_point_list = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTargetCpaPointListOrBuilder in interface AdGroupSimulationOrBuilder

    • hasTargetRoasPointList

      public boolean hasTargetRoasPointList()
       Output only. Simulation points if the simulation type is TARGET_ROAS.
      .google.ads.googleads.v18.common.TargetRoasSimulationPointList target_roas_point_list = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasTargetRoasPointList in interface AdGroupSimulationOrBuilder
      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.v18.common.TargetRoasSimulationPointList target_roas_point_list = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTargetRoasPointList in interface AdGroupSimulationOrBuilder
      Returns:
      The targetRoasPointList.

    • getTargetRoasPointListOrBuilder

      public TargetRoasSimulationPointListOrBuilder getTargetRoasPointListOrBuilder()
       Output only. Simulation points if the simulation type is TARGET_ROAS.
      .google.ads.googleads.v18.common.TargetRoasSimulationPointList target_roas_point_list = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTargetRoasPointListOrBuilder in interface AdGroupSimulationOrBuilder

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 AdGroupSimulation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdGroupSimulation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static AdGroupSimulation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AdGroupSimulation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AdGroupSimulation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AdGroupSimulation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AdGroupSimulation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AdGroupSimulation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static AdGroupSimulation.Builder newBuilder()

    • newBuilder

      public static AdGroupSimulation.Builder newBuilder(AdGroupSimulation prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AdGroupSimulation getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AdGroupSimulation> parser()

    • getParserForType

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