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

Resource: CampaignSimulation

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

SEARCH - CPC_BID - UNIFORM SEARCH - CPC_BID - SCALING SEARCH - TARGET_CPA - UNIFORM SEARCH - TARGET_CPA - SCALING SEARCH - TARGET_ROAS - UNIFORM SEARCH - TARGET_IMPRESSION_SHARE - UNIFORM SEARCH - BUDGET - UNIFORM SHOPPING - BUDGET - UNIFORM SHOPPING - TARGET_ROAS - UNIFORM MULTIPLE - TARGET_CPA - UNIFORM OWNED_AND_OPERATED - TARGET_CPA - DEFAULT DISPLAY - TARGET_CPA - UNIFORM

JSON representation
{
  "resourceName": string,
  "campaignId": string,
  "type": enum (SimulationType),
  "modificationMethod": enum (SimulationModificationMethod),
  "startDate": string,
  "endDate": string,

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

string

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

customers/{customerId}/campaignSimulations/{campaignId}~{type}~{modificationMethod}~{startDate}~{endDate}

campaignId

string (int64 format)

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

object (CpcBidSimulationPointList)

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

targetImpressionSharePointList

object (TargetImpressionShareSimulationPointList)

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

budgetPointList

object (BudgetSimulationPointList)

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

TargetImpressionShareSimulationPointList

A container for simulation points for simulations of type TARGET_IMPRESSION_SHARE.

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

object (TargetImpressionShareSimulationPoint)

Projected metrics for a specific target impression share value.

TargetImpressionShareSimulationPoint

Projected metrics for a specific target impression share value.

JSON representation
{
  "targetImpressionShareMicros": string,
  "requiredCpcBidCeilingMicros": string,
  "requiredBudgetAmountMicros": string,
  "biddableConversions": number,
  "biddableConversionsValue": number,
  "clicks": string,
  "costMicros": string,
  "impressions": string,
  "topSlotImpressions": string,
  "absoluteTopImpressions": string
}
Fields
targetImpressionShareMicros

string (int64 format)

The simulated target impression share value (in micros) upon which projected metrics are based. E.g. 10% impression share, which is equal to 0.1, is stored as 100_000. This value is validated and will not exceed 1M (100%).

requiredCpcBidCeilingMicros

string (int64 format)

Projected required daily cpc bid ceiling that the advertiser must set to realize this simulation, in micros of the advertiser currency.

requiredBudgetAmountMicros

string (int64 format)

Projected required daily budget that the advertiser must set in order to receive the estimated traffic, in micros of advertiser currency.

biddableConversions

number

Projected number of biddable conversions.

biddableConversionsValue

number

Projected total value of biddable conversions.

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.

absoluteTopImpressions

string (int64 format)

Projected number of absolute top impressions. Only search advertising channel type supports this field.

BudgetSimulationPointList

A container for simulation points for simulations of type BUDGET.

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

object (BudgetSimulationPoint)

Projected metrics for a series of budget amounts.

BudgetSimulationPoint

Projected metrics for a specific budget amount.

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

string (int64 format)

The simulated budget upon which projected metrics are based.

requiredCpcBidCeilingMicros

string (int64 format)

Projected required daily cpc bid ceiling that the advertiser must set to realize this simulation, in micros of the advertiser currency. Only campaigns with the Target Spend bidding strategy support this field.

biddableConversions

number

Projected number of biddable conversions.

biddableConversionsValue

number

Projected total value of biddable conversions.

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.

Methods

get

Returns the requested campaign simulation in full detail.