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.adGroupSimulations

Resource: AdGroupSimulation

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
  8. VIDEO - CPV_BID - DEFAULT
  9. VIDEO - CPV_BID - UNIFORM
JSON representation 
{
  "resourceName": string,
  "type": enum (SimulationType),
  "modificationMethod": enum (SimulationModificationMethod),
  "adGroupId": string,
  "startDate": string,
  "endDate": string,

  // Union field point_list can be only one of the following:
  "cpcBidPointList": {
    object (CpcBidSimulationPointList)
  },
  "cpvBidPointList": {
    object (CpvBidSimulationPointList)
  },
  "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 ad group simulation. Ad group simulation resource names have the form:

customers/{customerId}/adGroupSimulations/{adGroupId}~{type}~{modificationMethod}~{startDate}~{endDate}
type

enum (SimulationType)

Output only. The field that the simulation modifies.
modificationMethod

enum (SimulationModificationMethod)

Output only. How the simulation modifies the field.
adGroupId

string (int64 format)

Output only. Ad group id of the simulation.
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:
cpcBidPointList

object (CpcBidSimulationPointList)

Output only. Simulation points if the simulation type is CPC_BID.
cpvBidPointList

object (CpvBidSimulationPointList)

Output only. Simulation points if the simulation type is CPV_BID.
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.

CpvBidSimulationPointList

A container for simulation points for simulations of type CPV_BID.

JSON representation 
{
  "points": [
    {
      object (CpvBidSimulationPoint)
    }
  ]
}
Fields
points[]

object (CpvBidSimulationPoint)

Projected metrics for a series of CPV bid amounts.

CpvBidSimulationPoint

Projected metrics for a specific CPV bid amount.

JSON representation 
{
  "cpvBidMicros": string,
  "costMicros": string,
  "impressions": string,
  "views": string
}
Fields
cpvBidMicros

string (int64 format)

The simulated CPV bid upon which projected metrics are based.
costMicros

string (int64 format)

Projected cost in micros.
impressions

string (int64 format)

Projected number of impressions.
views

string (int64 format)

Projected number of views.

Methods

get

 Returns the requested ad group simulation in full detail.