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

Resource: CampaignCriterionSimulation

A campaign criterion simulation. Supported combinations of advertising channel type, criterion ids, simulation type and simulation modification method is detailed below respectively.

  1. SEARCH - 30000,30001,30002 - BID_MODIFIER - UNIFORM
  2. SHOPPING - 30000,30001,30002 - BID_MODIFIER - UNIFORM
  3. DISPLAY - 30001 - BID_MODIFIER - UNIFORM
JSON representation
{
  "resourceName": string,
  "type": enum (SimulationType),
  "modificationMethod": enum (SimulationModificationMethod),
  "campaignId": string,
  "criterionId": string,
  "startDate": string,
  "endDate": string,
  "bidModifierPointList": {
    object (BidModifierSimulationPointList)
  }
}
Fields
resourceName

string

Output only. The resource name of the campaign criterion simulation. Campaign criterion simulation resource names have the form:

customers/{customerId}/campaignCriterionSimulations/{campaignId}~{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.

campaignId

string (int64 format)

Output only. Campaign 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.

bidModifierPointList

object (BidModifierSimulationPointList)

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

BidModifierSimulationPointList

A container for simulation points for simulations of type BID_MODIFIER.

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

object (BidModifierSimulationPoint)

Projected metrics for a series of bid modifier amounts.

BidModifierSimulationPoint

Projected metrics for a specific bid modifier amount.

JSON representation
{
  "bidModifier": number,
  "biddableConversions": number,
  "biddableConversionsValue": number,
  "clicks": string,
  "costMicros": string,
  "impressions": string,
  "topSlotImpressions": string,
  "parentBiddableConversions": number,
  "parentBiddableConversionsValue": number,
  "parentClicks": string,
  "parentCostMicros": string,
  "parentImpressions": string,
  "parentTopSlotImpressions": string,
  "parentRequiredBudgetMicros": string
}
Fields
bidModifier

number

The simulated bid modifier upon which projected metrics are based.

biddableConversions

number

Projected number of biddable conversions. Only search advertising channel type supports this field.

biddableConversionsValue

number

Projected total value of biddable conversions. Only search advertising channel type supports this field.

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. Only search advertising channel type supports this field.

parentBiddableConversions

number

Projected number of biddable conversions for the parent resource. Only search advertising channel type supports this field.

parentBiddableConversionsValue

number

Projected total value of biddable conversions for the parent resource. Only search advertising channel type supports this field.

parentClicks

string (int64 format)

Projected number of clicks for the parent resource.

parentCostMicros

string (int64 format)

Projected cost in micros for the parent resource.

parentImpressions

string (int64 format)

Projected number of impressions for the parent resource.

parentTopSlotImpressions

string (int64 format)

Projected number of top slot impressions for the parent resource. Only search advertising channel type supports this field.

parentRequiredBudgetMicros

string (int64 format)

Projected minimum daily budget that must be available to the parent resource to realize this simulation.

Methods

get

Returns the requested campaign criterion simulation in full detail.