ReportTypes

A reportType resource identifies a specific report that a channel or content owner can retrieve.

Methods

The following table shows the methods that the API supports for report resources.

Methods
list	Returns a list of report types that the channel or content owner can retrieve.

JSON resource representation

The JSON structure below shows the format of a reportType resource:

{
  "id": string,
  "name": string,
  "deprecateTime": timestamp,
  "systemManaged": boolean
}

Properties

The following table defines the properties that appear in this resource:

Properties
id	string The ID that YouTube uses to uniquely identify the report. The property value has a maximum length of 100 characters. The table below identifies the most recent version of each supported report type (max. 100 characters). See supported reports for channels Reports channel_basic_a2 User activity channel_province_a2 User activity by province channel_playback_location_a2 Playback locations channel_traffic_source_a2 Traffic sources channel_device_os_a2 Device and operating system channel_demographics_a1 Demographics channel_sharing_service_a1 Sharing services channel_annotations_a1 Annotations channel_cards_a1 Cards channel_end_screens_a1 End screens channel_subtitles_a2 Subtitles channel_combined_a2 Combined audience_retention_a1 Audience retention for videos playlist_basic_a1 Playlist user activity playlist_province_a1 Playlist user activity by province playlist_playback_location_a1 Playlist playback locations playlist_traffic_source_a1 Playlist traffic sources playlist_device_os_a1 Playlist device and operating system playlist_combined_a1 Playlist combined See supported reports for content owners Reports content_owner_basic_a3 User activity content_owner_province_a2 User activity by provinces content_owner_playback_location_a2 Playback locations content_owner_traffic_source_a2 Traffic sources content_owner_device_os_a2 Device and operating system content_owner_demographics_a1 Demographics content_owner_sharing_service_a1 Sharing services content_owner_annotations_a1 Annotations content_owner_cards_a1 Cards content_owner_end_screens_a1 End screens content_owner_subtitles_a2 Subtitles content_owner_combined_a2 Combined content_owner_playlist_basic_a1 Playlist user activity content_owner_playlist_province_a1 Playlist user activity by province content_owner_playlist_playback_location_a1 Playlist playback locations content_owner_playlist_traffic_source_a1 Playlist traffic sources content_owner_playlist_device_os_a1 Playlist device and operating system content_owner_playlist_combined_a1 Playlist combined content_owner_ad_rates_a1 Ad performance content_owner_estimated_revenue_a1 Estimated revenue by video content_owner_asset_estimated_revenue_a1 Estimated revenue by asset content_owner_asset_basic_a2 User activity for assets content_owner_asset_province_a2 User activity by province for assets content_owner_asset_playback_location_a2 Asset playback locations content_owner_asset_traffic_source_a2 Asset traffic sources content_owner_asset_device_os_a2 Asset device and operating system content_owner_asset_demographics_a1 Asset demographics content_owner_asset_sharing_service_a1 Asset sharing services content_owner_asset_annotations_a1 Asset annotations content_owner_asset_cards_a1 Asset cards content_owner_asset_end_screens_a1 Asset end screens content_owner_asset_combined_a2 Asset combined See supported system-managed reports (for content owners) System-managed reports content_owner_ad_revenue_raw_a1 Granular ad revenue per video content_owner_ad_revenue_summary_a1 Aggregate ad revenue per video content_owner_asset_ad_revenue_raw_a1 Granular ad revenue per asset content_owner_asset_ad_revenue_summary_a1 Aggregate ad revenue per asset content_owner_claim_ad_revenue_summary_a1 Claims (this report does not contain revenue data)
name	string The name of the report. The property value has a maximum length of 100 characters.
deprecateTime	timestamp The date and time that the report was or will be deprecated. If you have a job for a deprecated report type, YouTube generates new reports for that job for three months after the deprecation date has been announced. For example, the deprecation announcement for the content_owner_basic_a1 report was on May 19, 2016. Thus, the deprecateTime field for that report type specifies a time on August 19, 2016, after which YouTube will stop generating reports of that type.
systemManaged	boolean This value is true if YouTube automatically generates the report for YouTube content owners without content owners needing to first call the jobs.create method to instruct YouTube to generate the report. In fact, the jobs.create method returns an error if the reportTypeId property identifies a system-managed report.