AI-generated Key Takeaways
-
A
reportTyperesource in the YouTube API defines a specific report that can be retrieved by a channel or content owner. -
The API supports listing available report types via the
reportTypes.listmethod, enabling users to identify the reports they can access. -
Each
reportTyperesource is represented in JSON and includes properties such asid,name,deprecateTime, andsystemManaged, detailing the report's identifier, name, deprecation status, and whether it is system-managed. -
The
idproperty of a report type can help identify the most recent version of the report, and there are different reports for channels, content owners and system managed. -
The
systemManagedproperty indicates whether a report is automatically generated by YouTube for content owners, or if they need to use the jobs.create method to initiate report generation.
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:
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).
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.