Method: tvCampaignSummaries.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of TV campaign summaries.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/tvCampaignSummaries
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
profileId |
string (int64 format)
Required. User profile ID associated with this request.
|
Query parameters
Parameters |
accountId |
string (int64 format)
Required. Account ID associated with this request.
|
name |
string
Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field.
|
Request body
The request body must be empty.
Response body
Response message for TvCampaignSummariesService.List.
If successful, the response body contains data with the following structure:
JSON representation |
{
"kind": string,
"tvCampaignSummaries": [
{
object (TvCampaignSummary )
}
]
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#tvCampaignSummariesListResponse"
.
|
tvCampaignSummaries[] |
object (TvCampaignSummary )
tvCampaignSummaries.list of TV campaign summaries.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
TvCampaignSummary
TvCampaignSummary contains aggregate data from a TV campaign.
JSON representation |
{
"id": string,
"name": string,
"type": enum (CampaignComponentType ),
"spend": number,
"impressions": string,
"grp": string,
"startDate": string,
"endDate": string,
"kind": string
} |
Fields |
id |
string
ID of this TV campaign.
|
name |
string
Identifier. Name of this TV campaign.
|
type |
enum (CampaignComponentType )
"CampaignComponentType"
of this TV campaign.
|
spend |
number
Spend across the entire TV campaign.
|
impressions |
string (int64 format)
Impressions across the entire TV campaign.
|
grp |
string (int64 format)
GRP of this TV campaign.
|
startDate |
string
The start date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd".
|
endDate |
string
The end date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd".
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#tvCampaignSummary"
.
|
CampaignComponentType
Enum listing the different types of TV campaigns.
Enums |
CAMPAIGN_COMPONENT_TYPE_UNSPECIFIED |
Required to exist; do not use. |
COMPANY |
Company. |
BRAND |
Brand. |
PRODUCT |
Product. |
CAMPAIGN |
Campaign. |
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\u003eRetrieves a list of TV campaign summaries with aggregate data, including spend, impressions, and GRP.\u003c/p\u003e\n"],["\u003cp\u003eFilter the list by account ID and name using query parameters.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/dfatrafficking\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of TV campaign summaries, each containing details like ID, name, type, and date range.\u003c/p\u003e\n"],["\u003cp\u003eCampaign summaries can be categorized by \u003ccode\u003eCOMPANY\u003c/code\u003e, \u003ccode\u003eBRAND\u003c/code\u003e, \u003ccode\u003ePRODUCT\u003c/code\u003e, or \u003ccode\u003eCAMPAIGN\u003c/code\u003e component types.\u003c/p\u003e\n"]]],[],null,["# Method: tvCampaignSummaries.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.TvCampaignSummariesListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [TvCampaignSummary](#TvCampaignSummary)\n - [JSON representation](#TvCampaignSummary.SCHEMA_REPRESENTATION)\n- [CampaignComponentType](#CampaignComponentType)\n- [Try it!](#try-it)\n\nRetrieves a list of TV campaign summaries.\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/tvCampaignSummaries`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. User profile ID associated with this request. |\n\n### Query parameters\n\n| Parameters ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `account``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. Account ID associated with this request. |\n| `name` | `string` Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for TvCampaignSummariesService.List.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"tvCampaignSummaries\": [ { object (/doubleclick-advertisers/rest/v4/tvCampaignSummaries/list#TvCampaignSummary) } ] } ``` |\n\n| Fields ||\n|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#tvCampaignSummariesListResponse\"` . |\n| `tv``Campaign``Summaries[]` | `object (`[TvCampaignSummary](/doubleclick-advertisers/rest/v4/tvCampaignSummaries/list#TvCampaignSummary)`)` tvCampaignSummaries.list of TV campaign summaries. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`\n\nTvCampaignSummary\n-----------------\n\nTvCampaignSummary contains aggregate data from a TV campaign.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"name\": string, \"type\": enum (/doubleclick-advertisers/rest/v4/tvCampaignSummaries/list#CampaignComponentType), \"spend\": number, \"impressions\": string, \"grp\": string, \"startDate\": string, \"endDate\": string, \"kind\": string } ``` |\n\n| Fields ||\n|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` ID of this TV campaign. |\n| `name` | `string` Identifier. Name of this TV campaign. |\n| `type` | `enum (`[CampaignComponentType](/doubleclick-advertisers/rest/v4/tvCampaignSummaries/list#CampaignComponentType)`)` `\"CampaignComponentType\"` of this TV campaign. |\n| `spend` | `number` Spend across the entire TV campaign. |\n| `impressions` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Impressions across the entire TV campaign. |\n| `grp` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` GRP of this TV campaign. |\n| `start``Date` | `string` The start date of the TV campaign, inclusive. A string of the format: \"yyyy-MM-dd\". |\n| `end``Date` | `string` The end date of the TV campaign, inclusive. A string of the format: \"yyyy-MM-dd\". |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#tvCampaignSummary\"` . |\n\nCampaignComponentType\n---------------------\n\nEnum listing the different types of TV campaigns.\n\n| Enums ||\n|---------------------------------------|--------------------------------|\n| `CAMPAIGN_COMPONENT_TYPE_UNSPECIFIED` | Required to exist; do not use. |\n| `COMPANY` | Company. |\n| `BRAND` | Brand. |\n| `PRODUCT` | Product. |\n| `CAMPAIGN` | Campaign. |"]]