Jobs
Stay organized with collections
Save and categorize content based on your preferences.
A
job
resource represents a scheduled reporting job. A reporting job identifies a specific report that YouTube generates each day for a particular channel or content owner.
Methods
The following table shows the methods that the API supports for
job
resources.
Methods
|
create
|
Creates a reporting job. By creating a reporting job, you are instructing YouTube to generate that report on a daily basis. The report is available within 24 hours of the time that the job is created.
|
delete
|
Deletes a reporting job.
|
get
|
Retrieves information about a specific reporting job that has been scheduled for a channel or content owner.
|
list
|
Lists reporting jobs that have been scheduled for a channel or content owner. Each resource in the response contains an
id
property, which specifies the ID that YouTube uses to uniquely identify the job. You need that ID to retrieve the list of reports that have been generated for the job or to delete the job.
|
Properties
The following table defines the properties that appear in this resource:
Properties
|
id
|
string
The ID that YouTube uses to uniquely identify the reporting job. The value has a maximum length of 40 characters.
|
reportTypeId
|
string
The type of report that the job creates. The property value corresponds to the
id
of a
id
of a
reportType
as retrieved from the
reportTypes.list
method.
|
name
|
string
A name that YouTube generates to describe the job. The value has a maximum length of 100 characters.
|
createTime
|
timestamp
The date and time that the job was created. The property value is a timestamp in RFC3339 UTC "Zulu" format, accurate to microseconds. Example:
"2015-10-02T15:01:23.045678Z"
.
|
expireTime
|
timestamp
The date and time that the job expired or will expire. The property value is a timestamp in RFC3339 UTC "Zulu" format, accurate to microseconds. Example:
"2015-10-02T15:01:23.045678Z"
.
This property has a value if the report type associated with the job has been deprecated or if reports generated for the job have not been downloaded for a prolonged period of time. The value marks the date after which YouTube no longer generates new reports for the job.
If you have a job that identifies an expiration date, you should update your systems to stop requesting the report by that date. In some cases, a replacement report may be available.
|
systemManaged
|
boolean
This value is
true
if the job generates system-managed reports. YouTube automatically generates system-managed reports for the YouTube content owners who have access to the same reports in the
YouTube Creator Studio
. Content owners cannot modify or delete jobs that create those reports.
|
Except as otherwise noted, the content of this page is licensed under the
Creative Commons Attribution 4.0 License
, and code samples are licensed under the
Apache 2.0 License
. For details, see the
Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-09-29 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]