REST Resource: tvCampaignDetails
Stay organized with collections
Save and categorize content based on your preferences.
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. |
WEEKS_ONE |
One week. |
WEEKS_FOUR |
Four weeks. |
WEEKS_EIGHT |
Eight weeks. |
WEEKS_TWELVE |
Twelve weeks. |
Methods |
|
|
Gets one TvCampaignDetail by ID. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eTvCampaignDetail holds TV campaign data for specific start dates and date windows, including an ID, timepoints, and resource kind.\u003c/p\u003e\n"],["\u003cp\u003eTvCampaignTimepoint represents a single data point within a TvCampaignDetail, containing the start date, date window, and spend for that period.\u003c/p\u003e\n"],["\u003cp\u003eTvCampaignDateWindow defines the possible timeframes for a TV campaign, ranging from one to twelve weeks.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides a method to retrieve a specific TvCampaignDetail using its unique ID.\u003c/p\u003e\n"]]],[],null,["# REST Resource: tvCampaignDetails\n\n- [Resource: TvCampaignDetail](#TvCampaignDetail)\n - [JSON representation](#TvCampaignDetail.SCHEMA_REPRESENTATION)\n- [TvCampaignTimepoint](#TvCampaignTimepoint)\n - [JSON representation](#TvCampaignTimepoint.SCHEMA_REPRESENTATION)\n- [TvCampaignDateWindow](#TvCampaignDateWindow)\n- [Methods](#METHODS_SUMMARY)\n\nResource: TvCampaignDetail\n--------------------------\n\nTvCampaignDetail contains data from a TV campaign for specific start dates and date windows.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"timepoints\": [ { object (/doubleclick-advertisers/rest/v4/tvCampaignDetails#TvCampaignTimepoint) } ], \"kind\": string } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` ID of this TV campaign. |\n| `timepoints[]` | `object (`[TvCampaignTimepoint](/doubleclick-advertisers/rest/v4/tvCampaignDetails#TvCampaignTimepoint)`)` The timepoints of the TV campaign. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#tvCampaignSummary\"` . |\n\nTvCampaignTimepoint\n-------------------\n\nA single data point for TvCampaignDetail, which holds information about the TV campaign for a specific start date and date window.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"startDate\": string, \"dateWindow\": enum (/doubleclick-advertisers/rest/v4/tvCampaignDetails#TvCampaignDateWindow), \"spend\": number } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------|\n| `start``Date` | `string` The start date of the timepoint. A string in the format of \"yyyy-MM-dd\". |\n| `date``Window` | `enum (`[TvCampaignDateWindow](/doubleclick-advertisers/rest/v4/tvCampaignDetails#TvCampaignDateWindow)`)` The date window of the timepoint. |\n| `spend` | `number` The spend within the time range of the timepoint. |\n\nTvCampaignDateWindow\n--------------------\n\nEnumeration of date windows for TV campaigns.\n\n| Enums ||\n|---------------------|-------------------------------------|\n| `WEEKS_UNSPECIFIED` | Default value, should never be set. |\n| `WEEKS_ONE` | One week. |\n| `WEEKS_FOUR` | Four weeks. |\n| `WEEKS_EIGHT` | Eight weeks. |\n| `WEEKS_TWELVE` | Twelve weeks. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------|----------------------------------|\n| ### [get](/doubleclick-advertisers/rest/v4/tvCampaignDetails/get) | Gets one TvCampaignDetail by ID. |"]]
