com.google.ads.googleads.v17.resources.CampaignSimulationOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/resources/campaign_simulation.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;

public interface CampaignSimulationOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.CampaignSimulation)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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) = { ... }
   * @return The resourceName.
   */
  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) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

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

  /**
   *    * Output only. The field that the simulation modifies.
   * 
   *
   * .google.ads.googleads.v17.enums.SimulationTypeEnum.SimulationType type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * Output only. The field that the simulation modifies.
   * 
   *
   * .google.ads.googleads.v17.enums.SimulationTypeEnum.SimulationType type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The type.
   */
  com.google.ads.googleads.v17.enums.SimulationTypeEnum.SimulationType getType();

  /**
   *    * Output only. How the simulation modifies the field.
   * 
   *
   * .google.ads.googleads.v17.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for modificationMethod.
   */
  int getModificationMethodValue();
  /**
   *    * Output only. How the simulation modifies the field.
   * 
   *
   * .google.ads.googleads.v17.enums.SimulationModificationMethodEnum.SimulationModificationMethod modification_method = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The modificationMethod.
   */
  com.google.ads.googleads.v17.enums.SimulationModificationMethodEnum.SimulationModificationMethod getModificationMethod();

  /**
   *    * 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];
   * @return The startDate.
   */
  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];
   * @return The bytes for startDate.
   */
  com.google.protobuf.ByteString
      getStartDateBytes();

  /**
   *    * 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];
   * @return The endDate.
   */
  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];
   * @return The bytes for endDate.
   */
  com.google.protobuf.ByteString
      getEndDateBytes();

  /**
   *    * Output only. Simulation points if the simulation type is CPC_BID.
   * 
   *
   * .google.ads.googleads.v17.common.CpcBidSimulationPointList cpc_bid_point_list = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the cpcBidPointList field is set.
   */
  boolean hasCpcBidPointList();
  /**
   *    * Output only. Simulation points if the simulation type is CPC_BID.
   * 
   *
   * .google.ads.googleads.v17.common.CpcBidSimulationPointList cpc_bid_point_list = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The cpcBidPointList.
   */
  com.google.ads.googleads.v17.common.CpcBidSimulationPointList getCpcBidPointList();
  /**
   *    * Output only. Simulation points if the simulation type is CPC_BID.
   * 
   *
   * .google.ads.googleads.v17.common.CpcBidSimulationPointList cpc_bid_point_list = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.common.CpcBidSimulationPointListOrBuilder getCpcBidPointListOrBuilder();

  /**
   *    * Output only. Simulation points if the simulation type is TARGET_CPA.
   * 
   *
   * .google.ads.googleads.v17.common.TargetCpaSimulationPointList target_cpa_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the targetCpaPointList field is set.
   */
  boolean hasTargetCpaPointList();
  /**
   *    * Output only. Simulation points if the simulation type is TARGET_CPA.
   * 
   *
   * .google.ads.googleads.v17.common.TargetCpaSimulationPointList target_cpa_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The targetCpaPointList.
   */
  com.google.ads.googleads.v17.common.TargetCpaSimulationPointList getTargetCpaPointList();
  /**
   *    * Output only. Simulation points if the simulation type is TARGET_CPA.
   * 
   *
   * .google.ads.googleads.v17.common.TargetCpaSimulationPointList target_cpa_point_list = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.common.TargetCpaSimulationPointListOrBuilder getTargetCpaPointListOrBuilder();

  /**
   *    * Output only. Simulation points if the simulation type is TARGET_ROAS.
   * 
   *
   * .google.ads.googleads.v17.common.TargetRoasSimulationPointList target_roas_point_list = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the targetRoasPointList field is set.
   */
  boolean hasTargetRoasPointList();
  /**
   *    * Output only. Simulation points if the simulation type is TARGET_ROAS.
   * 
   *
   * .google.ads.googleads.v17.common.TargetRoasSimulationPointList target_roas_point_list = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The targetRoasPointList.
   */
  com.google.ads.googleads.v17.common.TargetRoasSimulationPointList getTargetRoasPointList();
  /**
   *    * Output only. Simulation points if the simulation type is TARGET_ROAS.
   * 
   *
   * .google.ads.googleads.v17.common.TargetRoasSimulationPointList target_roas_point_list = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.common.TargetRoasSimulationPointListOrBuilder getTargetRoasPointListOrBuilder();

  /**
   *    * Output only. Simulation points if the simulation type is
   * TARGET_IMPRESSION_SHARE.
   * 
   *
   * .google.ads.googleads.v17.common.TargetImpressionShareSimulationPointList target_impression_share_point_list = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the targetImpressionSharePointList field is set.
   */
  boolean hasTargetImpressionSharePointList();
  /**
   *    * Output only. Simulation points if the simulation type is
   * TARGET_IMPRESSION_SHARE.
   * 
   *
   * .google.ads.googleads.v17.common.TargetImpressionShareSimulationPointList target_impression_share_point_list = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The targetImpressionSharePointList.
   */
  com.google.ads.googleads.v17.common.TargetImpressionShareSimulationPointList getTargetImpressionSharePointList();
  /**
   *    * Output only. Simulation points if the simulation type is
   * TARGET_IMPRESSION_SHARE.
   * 
   *
   * .google.ads.googleads.v17.common.TargetImpressionShareSimulationPointList target_impression_share_point_list = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.common.TargetImpressionShareSimulationPointListOrBuilder getTargetImpressionSharePointListOrBuilder();

  /**
   *    * Output only. Simulation points if the simulation type is BUDGET.
   * 
   *
   * .google.ads.googleads.v17.common.BudgetSimulationPointList budget_point_list = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the budgetPointList field is set.
   */
  boolean hasBudgetPointList();
  /**
   *    * Output only. Simulation points if the simulation type is BUDGET.
   * 
   *
   * .google.ads.googleads.v17.common.BudgetSimulationPointList budget_point_list = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The budgetPointList.
   */
  com.google.ads.googleads.v17.common.BudgetSimulationPointList getBudgetPointList();
  /**
   *    * Output only. Simulation points if the simulation type is BUDGET.
   * 
   *
   * .google.ads.googleads.v17.common.BudgetSimulationPointList budget_point_list = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   */
  com.google.ads.googleads.v17.common.BudgetSimulationPointListOrBuilder getBudgetPointListOrBuilder();

  com.google.ads.googleads.v17.resources.CampaignSimulation.PointListCase getPointListCase();
}