PricingSchedule

  • A pricing schedule defines the cost and timeframe for ad placements, including start and end dates, pricing type, and optional cap costs.

  • Pricing can be based on various models, such as CPM, CPC, CPA, or flat rates for impressions or clicks.

  • Pricing periods allow for setting specific costs and unit amounts within the overall placement schedule.

  • Cap cost options can be set to none, monthly, or cumulative to control spending limits.

  • Floodlight activity IDs can be associated with placements for CPA pricing to track conversions.

Pricing Schedule

JSON representation 
{
  "testingStartDate": string,
  "startDate": string,
  "endDate": string,
  "pricingType": enum (PlacementPricingType),
  "capCostOption": enum (PlacementCapCostOption),
  "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 (PlacementPricingType)

Placement pricing type. This field is required on insertion.
capCostOption

enum (PlacementCapCostOption)

Placement cap cost option.
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

.

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., multiplied by 1000000000). Acceptable values are

0

to

1000000000000000000

, inclusive.
pricingComment

string

Comments for this pricing period.