Method: tvCampaignSummaries.list

  • 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 profileId and query parameters for accountId and name.

  • The request body must be empty, and the response body contains a JSON object with a list of tvCampaignSummaries.

  • The TvCampaignSummary resource 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/dfatrafficking OAuth scope.

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"

.