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

Interface CampaignSimulationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CampaignSimulation, CampaignSimulation.Builder
public interface CampaignSimulationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getResourceName

      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) = { ... }
      Returns:
      The resourceName.

    • getResourceNameBytes

      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) = { ... }
      Returns:
      The bytes for resourceName.

    • getCampaignId

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

    • getTypeValue

      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];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      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];
      Returns:
      The type.

    • getModificationMethodValue

      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];
      Returns:
      The enum numeric value on the wire for modificationMethod.

    • getModificationMethod

      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];
      Returns:
      The modificationMethod.

    • getStartDate

      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];
      Returns:
      The startDate.

    • getStartDateBytes

      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];
      Returns:
      The bytes for startDate.

    • getEndDate

      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];
      Returns:
      The endDate.

    • getEndDateBytes

      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];
      Returns:
      The bytes for endDate.

    • hasCpcBidPointList

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

    • getCpcBidPointList

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

    • getCpcBidPointListOrBuilder

      CpcBidSimulationPointListOrBuilder getCpcBidPointListOrBuilder()
       Output only. Simulation points if the simulation type is CPC_BID.
      .google.ads.googleads.v18.common.CpcBidSimulationPointList cpc_bid_point_list = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasTargetCpaPointList

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

    • getTargetCpaPointList

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

    • getTargetCpaPointListOrBuilder

      TargetCpaSimulationPointListOrBuilder getTargetCpaPointListOrBuilder()
       Output only. Simulation points if the simulation type is TARGET_CPA.
      .google.ads.googleads.v18.common.TargetCpaSimulationPointList target_cpa_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasTargetRoasPointList

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

    • getTargetRoasPointList

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

    • getTargetRoasPointListOrBuilder

      TargetRoasSimulationPointListOrBuilder getTargetRoasPointListOrBuilder()
       Output only. Simulation points if the simulation type is TARGET_ROAS.
      .google.ads.googleads.v18.common.TargetRoasSimulationPointList target_roas_point_list = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasTargetImpressionSharePointList

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

    • getTargetImpressionSharePointList

      TargetImpressionShareSimulationPointList getTargetImpressionSharePointList()
       Output only. Simulation points if the simulation type is
 TARGET_IMPRESSION_SHARE.
      .google.ads.googleads.v18.common.TargetImpressionShareSimulationPointList target_impression_share_point_list = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The targetImpressionSharePointList.

    • getTargetImpressionSharePointListOrBuilder

      TargetImpressionShareSimulationPointListOrBuilder getTargetImpressionSharePointListOrBuilder()
       Output only. Simulation points if the simulation type is
 TARGET_IMPRESSION_SHARE.
      .google.ads.googleads.v18.common.TargetImpressionShareSimulationPointList target_impression_share_point_list = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasBudgetPointList

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

    • getBudgetPointList

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

    • getBudgetPointListOrBuilder

      BudgetSimulationPointListOrBuilder getBudgetPointListOrBuilder()
       Output only. Simulation points if the simulation type is BUDGET.
      .google.ads.googleads.v18.common.BudgetSimulationPointList budget_point_list = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getPointListCase

      CampaignSimulation.PointListCase getPointListCase()