/v1/jobs

GET

/v1/jobs

Lists jobs.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://youtubereporting.googleapis.com//v1/jobs'

Response Example

{
    "jobs": [
        {
            "createTime": "string",
            "expireTime": "string",
            "id": "string",
            "name": "string",
            "reportTypeId": "string",
            "systemManaged": true
        }
    ],
    "nextPageToken": "string"
}

Request

Query Params

includeSystemManaged

string

optional

If set to true, also system-managed jobs will be returned; otherwise only user-created jobs will be returned. System-managed jobs can neither be modified nor deleted.

onBehalfOfContentOwner

string

optional

The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).

pageSize

integer

optional

Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.

pageToken

string

optional

A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the ListJobs method.

Responses

🟢200Successful response

application/json

Body

Response message for ReportingService.ListJobs.

jobs

array[object (Job) {6}]

optional

The list of jobs.

createTime

string <google-datetime>

optional

The creation date/time of the job.

expireTime

string <google-datetime>

optional

The date/time when this job will expire/expired. After a job expired, no new reports are generated.

string

optional

The server-generated ID of the job (max. 40 characters).

name

string

optional

The name of the job (max. 100 characters).

reportTypeId

string

optional

The type of reports this job creates. Corresponds to the ID of a ReportType.

systemManaged

boolean

optional

True if this a system-managed job that cannot be modified by the user; otherwise false.

nextPageToken

string

optional

A token to retrieve next page of results. Pass this value in the ListJobsRequest.page_token field in the subsequent call to ListJobs method to retrieve the next page of results.

Modified at 2023-08-15 05:44:52

/v1/jobs