REST Resource: tvCampaignDetails

  • TvCampaignDetail contains data from a TV campaign for specific start dates and date windows.

  • TvCampaignTimepoint is a single data point within TvCampaignDetail providing information for a specific start date and date window.

  • The TvCampaignDetail resource has fields for ID, timepoints, and resource kind.

  • The TvCampaignTimepoint resource includes fields for start date, date window, and spend.

  • The get method is used to retrieve a specific TvCampaignDetail by its ID.

Resource: TvCampaignDetail

TvCampaignDetail contains data from a TV campaign for specific start dates and date windows.

JSON representation 
{
  "id": string,
  "timepoints": [
    {
      object (TvCampaignTimepoint)
    }
  ],
  "kind": string
}
Fields
id

string

ID of this TV campaign.
timepoints[]

object (TvCampaignTimepoint)

The timepoints of the TV campaign.
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#tvCampaignSummary"

.

TvCampaignTimepoint

A single data point for TvCampaignDetail, which holds information about the TV campaign for a specific start date and date window.

JSON representation 
{
  "startDate": string,
  "dateWindow": enum (TvCampaignDateWindow),
  "spend": number
}
Fields
startDate

string

The start date of the timepoint. A string in the format of "yyyy-MM-dd".
dateWindow

enum (TvCampaignDateWindow)

The date window of the timepoint.
spend

number

The spend within the time range of the timepoint.

TvCampaignDateWindow

Enumeration of date windows for TV campaigns.

Enums
WEEKS_UNSPECIFIED Default value, should never be set.
DAYS_ONE One Day.
WEEKS_ONE One week.
WEEKS_FOUR Four weeks.
WEEKS_EIGHT Eight weeks.
WEEKS_TWELVE Twelve weeks.

Methods

get

 Gets one TvCampaignDetail by ID.