LineTerms

  • Line Terms define the seller-guaranteed terms for a line, including billable events and cost per billable event.

  • An Ad Play Plan details when and where ad plays are scheduled, along with duration and the number of billable events.

  • An Ad Play Plan Entry specifies details for a single ad play within a plan, including the ad unit, start and end times, total billable events, and play duration.

  • Attributes provide additional characteristics for a line element, such as an estimated number of ad plays.

The seller guaranteed terms for this line.

JSON representation 
{
  "billableEvents": string,
  "costPerBillableEvent": {
    object (Money)
  },
  "adPlayPlan": {
    object (AdPlayPlan)
  },
  "attribute": [
    {
      object (Attribute)
    }
  ]
}
Fields
billableEvents

string (int64 format)

Required. Total billable events based on the details of this line.
costPerBillableEvent

object (Money)

Required. Cost per billable event.
adPlayPlan

object (AdPlayPlan)

Optional. The ad play plan for this line.
attribute[]

object (Attribute)

A list of attributes for this line.

AdPlayPlan

An ad play plan for detailing when and where ad plays are planned to take place, as well as duration and number of billable events.

JSON representation 
{
  "adPlayPlanEntries": [
    {
      object (AdPlayPlanEntry)
    }
  ]
}
Fields
adPlayPlanEntries[]

object (AdPlayPlanEntry)

Required. The entries of this plan.

AdPlayPlanEntry

An entry to be included in the ad play plan.

Example:

adUnit: adUnits/123,
startDate: 1/1/19 10:00,
endDate: 1/1/19/ 11:00,
totalBillableEvents: 100,
playDuration: 300s

The entry above specifies that the ad will play on the ad unit with the id 123, on the date 1/1/19 between 10:00 and 11:00 for a total of 300 seconds resulting in 100 billable events.

JSON representation 
{
  "adUnit": string,
  "startTime": string,
  "endTime": string,
  "totalBillableEvents": string,
  "playDuration": string
}
Fields
adUnit

string

Required. The name of the AdUnit in this plan entry. Format = adUnits/123
startTime

string (Timestamp format)

Required. The start date and time for this plan entry (inclusive).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Required. The end date and time for this plan entry (exclusive).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
totalBillableEvents

string (int64 format)

Required. Number of planned billable events between the specified start and end times. A billable event is either an impression or an ad play.
playDuration

string (Duration format)

Required. The total amount of time the ad will be visible for.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

Attribute

An attribute of the element (e.g. ad play count) and its value.

JSON representation 
{
  "adPlayCount": {
    object (AdPlayCount)
  }
}
Fields
adPlayCount

object (AdPlayCount)

AdPlayCount

An estimated number of ad plays.

JSON representation 
{
  "value": string
}
Fields
value

string (int64 format)