/v1/jobs

POST

/v1/jobs

jobs

Creates a job and returns it.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://youtubereporting.googleapis.com//v1/jobs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "createTime": "string",
    "expireTime": "string",
    "id": "string",
    "name": "string",
    "reportTypeId": "string",
    "systemManaged": true
}'

Response Example

{
  "createTime": "string",
  "expireTime": "string",
  "id": "string",
  "name": "string",
  "reportTypeId": "string",
  "systemManaged": true
}

Request

Query Params

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).

Body Params application/json

A job creating reports of a specific type.

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.

Examples

Responses

🟢200Successful response

application/json

Body

A job creating reports of a specific type.

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.

/v1/jobs

/v1/jobs/{jobId}