The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Dec 24th, 2021. All users must migrate to a newer API version by that date.

PricingSchedule

Pricing Schedule

JSON representation
{
  "testingStartDate": string,
  "startDate": string,
  "endDate": string,
  "pricingType": enum (PricingType),
  "capCostOption": enum (CapCostOption),
  "disregardOverdelivery": boolean,
  "flighted": boolean,
  "pricingPeriods": [
    {
      object (PricingSchedulePricingPeriod)
    }
  ],
  "floodlightActivityId": string
}
Fields
testingStartDate

string

Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.

startDate

string

Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.

endDate

string

Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.

pricingType

enum (PricingType)

Placement pricing type. This field is required on insertion.

capCostOption

enum (CapCostOption)

Placement cap cost option.

disregardOverdelivery

boolean

Whether cap costs are ignored by ad serving.

flighted

boolean

Whether this placement is flighted. If true, pricing periods will be computed automatically.

pricingPeriods[]

object (PricingSchedulePricingPeriod)

Pricing periods for this placement.

floodlightActivityId

string (int64 format)

Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to

PRICING_TYPE_CPA

.

PricingType

Enums
PRICING_TYPE_CPM
PRICING_TYPE_CPC
PRICING_TYPE_CPA
PRICING_TYPE_FLAT_RATE_IMPRESSIONS
PRICING_TYPE_FLAT_RATE_CLICKS
PRICING_TYPE_CPM_ACTIVEVIEW

CapCostOption

Enums
CAP_COST_NONE
CAP_COST_MONTHLY
CAP_COST_CUMULATIVE

PricingSchedulePricingPeriod

Pricing Period

JSON representation
{
  "startDate": string,
  "endDate": string,
  "units": string,
  "rateOrCostNanos": string,
  "pricingComment": string
}
Fields
startDate

string

Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.

endDate

string

Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.

units

string (int64 format)

Units of this pricing period. Acceptable values are

0

to

10000000000

, inclusive.

rateOrCostNanos

string (int64 format)

Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are

0

to

1000000000000000000

, inclusive.

pricingComment

string

Comments for this pricing period.