Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.biddingStrategySimulations

Resource: BiddingStrategySimulation

A bidding strategy simulation. Supported combinations of simulation type and simulation modification method are detailed below respectively.

  1. TARGET_CPA - UNIFORM
  2. TARGET_ROAS - UNIFORM
JSON representation
{
  "resourceName": string,
  "biddingStrategyId": string,
  "type": enum (SimulationType),
  "modificationMethod": enum (SimulationModificationMethod),
  "startDate": string,
  "endDate": string,

  // Union field point_list can be only one of the following:
  "targetCpaPointList": {
    object (TargetCpaSimulationPointList)
  },
  "targetRoasPointList": {
    object (TargetRoasSimulationPointList)
  }
  // End of list of possible types for union field point_list.
}
Fields
resourceName

string

Output only. The resource name of the bidding strategy simulation. Bidding strategy simulation resource names have the form:

customers/{customerId}/biddingStrategySimulations/{biddingStrategyId}~{type}~{modificationMethod}~{startDate}~{endDate}

biddingStrategyId

string (int64 format)

Output only. Bidding strategy shared set id of the simulation.

type

enum (SimulationType)

Output only. The field that the simulation modifies.

modificationMethod

enum (SimulationModificationMethod)

Output only. How the simulation modifies the field.

startDate

string

Output only. First day on which the simulation is based, in YYYY-MM-DD format.

endDate

string

Output only. Last day on which the simulation is based, in YYYY-MM-DD format

Union field point_list. List of simulation points. point_list can be only one of the following:
targetCpaPointList

object (TargetCpaSimulationPointList)

Output only. Simulation points if the simulation type is TARGET_CPA.

targetRoasPointList

object (TargetRoasSimulationPointList)

Output only. Simulation points if the simulation type is TARGET_ROAS.

Methods

get

Returns the requested bidding strategy simulation in full detail.