System-Managed Reports - Fields

Stay organized with collections Save and categorize content based on your preferences.

Movies, Music, and TV

The following table defines fields that appear in YouTube Reporting API system-managed reports for movie, music, and TV partners:

Fields
adjustment_type This field indicates whether the row represents normal revenue data or an adjustment to previously reported revenue:
  • If the row represents normal revenue data, the field value is None. In addition, the data in that row reports data for the month associated with the report.
  • If the row represents an adjustment to previously reported data, the field contains one of the values in the list below. In this case, the row might contain data from months other than the month associated with the report. For example, the November 2016 report could contain adjustments applicable to events in October 2016 or other prior months.

    Possible adjustment types are:
    • Backpay - Payment that was withheld due to missing ownership.
    • Conflict Resolution - Payment that was withheld due to an ownership conflict. This is also a form of back payment.
    • Dispute Resolution - Payment related to a resolved dispute for revenue withheld prior to the current month’s payments.
    • Dispute Conflict Resolution - A backpay payment derived from a resolved dispute that was withheld due to ownership in conflict.
    • Spam Adjustment - Payment related to spam correction. This is a deduction, which AdSense reports as Invalid Activity - YouTube.
    • Revenue Correction - Payment related to a technical bug or data correction. This value could be a credit or a deduction.
administer_publish_rights Indicates whether the music label administers publishing rights, which means that it collects and manages royalty payments for songwriters, composers, or publishers, or other parties that own the composition. Possible values are True and False.
album The album on which a sound recording appears. The value has a maximum length of 255 bytes.
artist The name of the artist associated with the asset identified in the report row. The value has a maximum length of 255 bytes.
asset_channel_id The channel that owns the partner-uploaded video that is claimed by the asset (asset_id). The field value is a YouTube channel ID that uniquely identifies the channel. You can retrieve additional data about the channel using the YouTube Data API's channels.list method.
asset_id The YouTube asset ID that uniquely identifies the asset associated with the data in the row. You can retrieve additional data about the asset using the YouTube Content ID API's assets.list method or look up the asset at the studio.youtube.com Assets page.
asset_labels Asset labels that are associated with the asset. Asset labels provide a way to group assets into custom categories. The labels can then be used to search for assets, update groups of assets, create campaigns for labeled assets, filter YouTube Analytics, and more.
asset_title The asset's title.
asset_type The asset's type. Possible values are:
  • Art Track — Represents a track on YouTube of a sound recording that doesn't have a premium music video.
  • Composition — Represents a musical composition. A composition has metadata like ISWC and writers. It is the only asset type that can have multiple owners per territory. It may be embedded in a sound recording asset.
  • Movie — Represents a feature film. A movie has metadata like ISAN/EIDR and directors.
  • Music Video — Represents the official music video for a sound recording. A music video has metadata like Video ISRC, song, and artists. A music video asset embeds a sound recording asset.
  • Sound Recording — Represents an audio recording. A sound recording has metadata like ISRC, artist, and album. It embeds a composition asset, and may in turn be embedded in a music video asset.
  • Television episode — Represents an episode from a television show. An episode has metadata like season and episode number.
  • Web — Represents YouTube original video or other types of video content not covered by the other asset types.
category The video's genre, as displayed on the video's watch page. The value is a YouTube video category ID. You can use the YouTube Data API's videoCategories.list method to retrieve a mapping of video category IDs to category names.
channel_display_name The display name of the channel that uploaded the video.
channel_id The channel that owns the video (video_id) associated with the data in the row. The field value is a YouTube channel ID that uniquely identifies the channel. You can retrieve additional data about the channel using the YouTube Data API's channels.list method.
claim_origin The method by which the claim against the video was created. Possible field values are:
  • Audio Match
  • Audio Swap
  • Batch Tool
  • CMS_UPLOAD
  • Content ID API
  • Descriptive Search
  • External
  • GameID Match
  • Google Dev ID
  • Hashcode
  • Melody Match
  • SFTP Upload
  • Video Match
  • Web Search
  • Web Upload
  • YouTube Admin
claim_type Indicates whether the claim covers the audio, video, or audiovisual portion of the claimed content. Valid values for this field are:
  • Audio
  • Audio-Visual
  • Visual
composition_right_type Specifies the types of composition rights associated with the claim. Valid values for this field are:
  • Mechanical
  • Performance
  • Synchronization
content_type The source of the claimed video. Possible values are:
  • Partner-provided – The video that you upload to a YouTube channel that you own. You claim the video as you upload it, and apply a usage policy to it. Claiming partner-uploaded content enables monetization options, Content ID matching, and reporting.
  • Premium UGC – A video, which was uploaded by a third party, that contains copyrighted segments that meet the length and proportionality requirements to be treated the same as partner-provided licensed content.
  • UGC – A video, which was uploaded by a third party, that contains content that you own as determined by a Content ID match or a manual claim. The match policy associated with that claim determines where and how the video is available on YouTube.
country_code Identifies the country where the activity occurred. The value is an ISO 3166-1 alpha-2 country code.
custom_id A unique value that you, the metadata provider, use to identify an asset. The value could be a unique ID that you created for the asset or a standard identifier, such as an ISRC. The value has a maximum length of 64 bytes and may contain alphanumeric characters, hyphens (-), underscores (_), periods (.), "at" symbols (@), or forward slashes (/).
date The day that the activity occurred. The value is in YYYYMMDD format.
director Directors associated with the asset.
eidr The Entertainment Identifier Registry (EIDR) assigned to a movie or television episode. The value contains a standard prefix for EIDR registry, followed by a forward slash, a 20-character hexadecimal string, and an alphanumeric (0-9A-Z) check character.
episode_number The episode number associated with a video.
episode_title The title of a television or movie episode.
grid The Global Release Identifier, an optional metadata field used to uniquely identify an asset. The field's value contains exactly 18 alphanumeric characters.
hfa_song_code The six-character code issued by the Harry Fox Agency (HFA) to uniquely identify a composition.
isrc The International Standard Recording Code (ISRC) of the related asset. The field's value contains exactly 12 alphanumeric characters.
iswc The International Standard Musical Work Code (ISWC) of the composition asset. The field's value contains exactly 11 characters in the format of a letter (T) followed by 10 digits.
label The record label that released a sound recording. The value has a maximum length of 255 bytes.
multiple_claims Indicates whether there is more than one claim on the video. The value is false if there is one claim on the video and true if there is more than one.

Note: This field is called Multiple Claims? in reports downloadable from the Reports section of the YouTube Creator Studio.
music_claim_type Indicates whether the claim covers the audio, video, or audiovisual portion of the claimed content. Valid values for this field are:
  • Audio
  • Audio-Visual
  • Visual
owned_views The total number of views of your owned content for which the policy that you set for the content is either monetize or track.

YouTube ads reports and YouTube Red subscription reports for non-music content both contain the policy field, which indicates whether the policy associated with the data was monetize or track.
ownership_percentage The percentage of the composition that you own.
partner_revenue Your revenue from advertising after the revenue share split has been applied. This field appears in YouTube ads reports. The youtube_revenue_split field contains the total revenue before the revenue share split was applied.
partner_revenue_auction Your revenue from auction-sold AdSense advertising.
partner_revenue_partner_sold_partner_served Your revenue from advertisements that you sold and served from your own external ad servers.
partner_revenue_partner_sold_youtube_served Your revenue from advertising sold via DoubleClick for Publishers (DFP) after the revenue share split has been applied.
partner_revenue_reserved Your revenue from reserved-sold advertising via DoubleClick (DCLK) and other YouTube-sold sources after the revenue share split has been applied.
policy The policy applied to the video. The value is either monetize or track.
season The season number associated with a television episode. The field has a maximum length of 5 bytes.
studio The studio associated with the asset.
tms The 12- to 14-character Tribune Media Systems (TMS) ID value that uniquely identifies a movie or television episode.
upc The Universal Product Code (UPC), an optional metadata field used to uniquely identify an asset.
uploader The name of the user who uploaded the video.
video_duration_sec The length of the video in seconds.
video_id The claimed video associated with the data in the row. The field value is a YouTube video ID, which uniquely identifies the video. You can retrieve additional data about the video using the YouTube Data API's videos.list method.
video_title The title of the video associated with the data in the row..
writers A pipe-delimited list of the composition's writers.
youtube_revenue_split

For music labels, movie, and TV partners: Total YouTube ads revenue from your content. This amount is subsequently split according to the revenue share rate. The partner_revenue field contains your revenue.

For Music Publishers: Total YouTube ads revenue from your content, accounting for asset ownership, but prior to being split according to the revenue share rate. The partner_revenue field contains your revenue.

youtube_revenue_split_auction

For music labels, movie, and TV partners: Total revenue from auction-sold AdSense advertising prior to applying revenue share splits.

For Music Publishers: Total revenue from auction-sold AdSense advertising, accounting for asset ownership, but prior to applying revenue share splits.

youtube_revenue_split_partner_sold_partner_served

For music labels, movie, and TV partners: Total revenue from partner-sold, partner-served ads. This amount is subsequently split according to the revenue share rate. The partner_revenue_partner_served_partner_sold contains your revenue from partner-sold, partner-served ads.

For Music Publishers: Total revenue from partner-sold, partner-served ads, accounting for asset ownership. This amount is subsequently split according to the revenue share rate. The partner_revenue_partner_served_partner_sold contains your revenue from partner-sold, partner-served ads.

youtube_revenue_split_partner_sold_youtube_served

For music labels, movie, and TV partners: Total revenue from DoubleClick for Publishers (DFP). This amount is subsequently split according to the revenue share rate. The partner_revenue_partner_served_partner_sold contains your revenue from partner-sold, partner-served ads.

For Music Publishers: Total revenue from DoubleClick for Publishers (DFP), accounting for asset ownership. This amount is subsequently split according to the revenue share rate. The partner_revenue_partner_sold_youtube_sold contains your revenue from partner-sold, partner-served ads.

youtube_revenue_split_reserved

For music labels, movie, and TV partners: Total revenue from reserved-sold advertising via DoubleClick (DCLK) and other YouTube-sold sources. This amount is subsequently split according to the revenue share rate. The partner_revenue_reserved contains your revenue from these sources.

For Music Publishers: Total revenue from reserved-sold advertising via DoubleClick (DCLK) and other YouTube-sold sources, accounting for asset ownership. This amount is subsequently split according to the revenue share rate. The partner_revenue_reserved contains your revenue from these sources.

Primetime

The following table defines fields that appear in YouTube Reporting API system-managed reports for Primetime programming partners:

Fields
AgeGroup The age group of the viewers in the report. Note that there must be at least 50 viewing events by members of a particular age group for that group to be listed. Possible field values are:
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 45-54
  • 55-64
  • 65+
AverageViewDuration The average number of seconds viewed of the program across all viewing events.
AverageViewPercent The average percentage of the program that was viewed across all viewing events.
CallSign If applicable, identifies the call sign for the station on which the program aired.
ConcurrentViewers The total number of viewing events during which a particular minute of the episode, identified by the MinutesSinceStart field value, was viewed.
ContentId A unique value that you, the metadata provider, use to identify an asset and that you have provided to YouTube. You can use this value to reconcile the asset with your own content management system. The value can be a unique ID that you created for the asset or a standard identifier, such as a TMS ID. The value has a maximum length of 64 bytes and may contain alphanumeric characters, hyphens (-), underscores (_), periods (.), "at" symbols (@), or forward slashes (/).
ContentLength The duration of the program in seconds. Note that the duration of ads is not included for VOD programs with dynamic ad insertion (DAI).
ContentType The manner in which the viewer watched the content. Possible field values are:
  • DVR: The viewer recorded the program and saved it to their DVR.
  • Live: The viewer watched the program during its original live broadcast. For example, the viewer watched a live sporting event.
  • VOD: The viewer selected an episode or program available on an on-demand basis.
Date The date on which the program views occurred. The value is in YYYYMMDD format.
DeviceType The type of device on which the viewer watched the content. Note that there must be at least 50 viewing events for a particular device type for that device type to be listed. Possible field values are:
  • Computer
  • Console
  • Mobile Phone
  • Tablet
  • TV
DmaId The 3-digit identifier that Nielsen uses to identify the Designated Market Area (DMA)’s associated with the viewing events described in the data row.
EpisodeNumber If applicable, identifies the sequential episode number for the program within the specified season. The season is identified by the SeasonNumber field. For example, this value will be 1 for the first episode of the second season of a program.
Gender The gender of the viewers in the report. Note that there must be at least 50 viewing events by members of a particular gender for that gender to be listed. Possible field values are:
  • Male
  • Female
MinutesSinceStart The number of minutes from the start of a program when the viewing event started. Note that this number includes both program time and ad time with the exception of on-demand (VOD) programming that uses dynamic ad insertion (DAI). For VOD programming with DAI, the number includes only program time.
Network The station or network that released the content or on which the content aired.
PeakConcurrentViewers The maximum number of concurrent viewing events at any given minute of a particular program.
Platform The manner in which the viewer watched the content. Possible field values are:
  • Android
  • iOS
  • TV HTML5
  • Web
ProgramTitle The title or name of the episode, movie, or event.
ProgramType The type of program that the viewer watched. Possible field values are:
  • PROGRAM_TYPE_UNKNOWN
  • PROGRAM_TYPE_MOVIE
  • PROGRAM_TYPE_EPISODE
  • PROGRAM_TYPE_COMPLEX_EPISODE
  • PROGRAM_TYPE_SPORTS
  • PROGRAM_TYPE_SPECIAL
  • PROGRAM_TYPE_EVENT
  • PROGRAM_TYPE_PAID_PROGRAMMING
PublishDateTime The program's airing date or release date. The value is in YYYY-MM-DD format.
SeasonNumber The season number associated with the program. The field has a maximum length of 5 bytes.
SeriesTitle The title of the series associated with the data in the report row. For example, for a TV program, this value would specify the name of the show, and the ProgramTitle field would specify the title of the episode.
TmsId The 12- to 14-character Tribune Media Systems (TMS) ID value that uniquely identifies the program.
TotalWatchTime The total amount of time, in seconds, that the program was watched across all viewing events.
ViewersComplete The total number of live, DVR, and VOD viewing events during which the viewer stopped watching the video during a particular minute, which is identified by the MinutesSinceStart field value. If the MinutesSinceStart value represents a value shorter than the entire program (ContentLength), then these viewers stopped watching prior to the end of the program.
ViewersResume The total number of viewing events in which the viewer starts either a DVR program or a VOD program at any point other than within the first minute (minute 0) of the video.
ViewersStart The total number of viewing events in which any of the following are true:
  • The viewer joined a live stream at any minute of that program.
  • The viewer started a DVR program at any point within its first minute (minute 0).
  • The viewer started a VOD program at any point within its first minute (minute 0).
Views The total numbers of times that the program was viewed across all viewing events.