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

Resource: AdGroupCriterionSimulation

An ad group criterion simulation. Supported combinations of advertising channel type, criterion type, simulation type, and simulation modification method are detailed below respectively. Hotel AdGroupCriterion simulation operations starting in V5.

  1. DISPLAY - KEYWORD - CPC_BID - UNIFORM
  2. SEARCH - KEYWORD - CPC_BID - UNIFORM
  3. SHOPPING - LISTING_GROUP - CPC_BID - UNIFORM
  4. HOTEL - LISTING_GROUP - CPC_BID - UNIFORM
  5. HOTEL - LISTING_GROUP - PERCENT_CPC_BID - UNIFORM
JSON representation 
{
  "resourceName": string,
  "type": enum (SimulationType),
  "modificationMethod": enum (SimulationModificationMethod),
  "adGroupId": string,
  "criterionId": string,
  "startDate": string,
  "endDate": string,

  // Union field point_list can be only one of the following:
  "cpcBidPointList": {
    object (CpcBidSimulationPointList)
  },
  "percentCpcBidPointList": {
    object (PercentCpcBidSimulationPointList)
  }
  // End of list of possible types for union field point_list.
}
Fields
resourceName

string

Output only. The resource name of the ad group criterion simulation. Ad group criterion simulation resource names have the form:

customers/{customerId}/adGroupCriterionSimulations/{adGroupId}~{criterionId}~{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. AdGroup ID of the simulation.
criterionId

string (int64 format)

Output only. Criterion 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.
percentCpcBidPointList

object (PercentCpcBidSimulationPointList)

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

PercentCpcBidSimulationPointList

A container for simulation points for simulations of type PERCENT_CPC_BID.

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

object (PercentCpcBidSimulationPoint)

Projected metrics for a series of percent CPC bid amounts.

PercentCpcBidSimulationPoint

Projected metrics for a specific percent CPC amount. Only Hotel advertising channel type supports this field.

JSON representation 
{
  "percentCpcBidMicros": string,
  "biddableConversions": number,
  "biddableConversionsValue": number,
  "clicks": string,
  "costMicros": string,
  "impressions": string,
  "topSlotImpressions": string
}
Fields
percentCpcBidMicros

string (int64 format)

The simulated percent CPC upon which projected metrics are based. Percent CPC expressed as fraction of the advertised price for some good or service. The value stored here is 1,000,000 * [fraction].
biddableConversions

number

Projected number of biddable conversions.
biddableConversionsValue

number

Projected total value of biddable conversions in local currency.
clicks

string (int64 format)

Projected number of clicks.
costMicros

string (int64 format)

Projected cost in micros.
impressions

string (int64 format)

Projected number of impressions.
topSlotImpressions

string (int64 format)

Projected number of top slot impressions.

Methods

get

 Returns the requested ad group criterion simulation in full detail.