AI-generated Key Takeaways
-
Retrieves a list of TV campaign summaries with aggregate data, including spend, impressions, and GRP.
-
Filter the list by account ID and name using query parameters.
-
Requires authorization with the
https://www.googleapis.com/auth/dfatrafficking
scope. -
Response includes a list of TV campaign summaries, each containing details like ID, name, type, and date range.
-
Campaign summaries can be categorized by
COMPANY
,BRAND
,PRODUCT
, orCAMPAIGN
component types.
- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- TvCampaignSummary
- Try it!
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 |
Required. User profile ID associated with this request. |
Query parameters
Parameters | |
---|---|
accountId |
Required. Account ID associated with this request. |
name |
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 ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
tvCampaignSummaries[] |
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 ( |
Fields | |
---|---|
id |
ID of this TV campaign. |
name |
Identifier. Name of this TV campaign. |
type |
of this TV campaign. |
spend |
Spend across the entire TV campaign. |
impressions |
Impressions across the entire TV campaign. |
grp |
GRP of this TV campaign. |
startDate |
The start date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd". |
endDate |
The end date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd". |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |