AI-generated Key Takeaways
-
This document outlines how to retrieve a list of TV campaign summaries using an HTTP GET request to a specified URL endpoint.
-
The request requires path parameters for
profileIdand query parameters foraccountIdandname. -
The request body must be empty, and the response body contains a JSON object with a list of
tvCampaignSummaries. -
The
TvCampaignSummaryresource provides aggregate data about a TV campaign, including its ID, name, type, spend, impressions, GRP, start date, and end date. -
Authorization requires the
https://www.googleapis.com/auth/dfatraffickingOAuth scope.
- 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
. |