Method: tvCampaignSummaries.list

    • The page provides documentation for retrieving a list of TV campaign summaries via an HTTP GET request.

    • The request requires path parameters for the user profile ID and query parameters for the account ID and campaign name.

    • The response body is a JSON object containing a list of TvCampaignSummary objects.

    • Each TvCampaignSummary object includes details such as ID, name, type, spend, impressions, GRP, start date, and end date.

    • Authorization for this request 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/v5/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.
    countryDartId

    string ( int64 format)

    Optional. Country Dart ID. If not specified, defaults to 256 (US).
    tvDataProvider

    enum ( TvDataProvider )

    Optional. TV data provider. If not specified, defaults to COMSCORE_NATIONAL_US .

    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"

    .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: