Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
Google_Service_YouTubeReporting_Jobs_Resource Class Reference

The "jobs" collection of methods. More...

Inheritance diagram for Google_Service_YouTubeReporting_Jobs_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 create (Google_Service_YouTubeReporting_Job $postBody, $optParams=array())
 Creates a job and returns it.
 
 delete ($jobId, $optParams=array())
 Deletes a job.
 
 get ($jobId, $optParams=array())
 Gets a job.
 
 listJobs ($optParams=array())
 Lists jobs.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "jobs" collection of methods.

Typical usage is: $youtubereportingService = new Google_Service_YouTubeReporting(...); $jobs = $youtubereportingService->jobs;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ create()

Google_Service_YouTubeReporting_Jobs_Resource::create ( Google_Service_YouTubeReporting_Job $postBody,
$optParams = array() )

Creates a job and returns it.

(jobs.create)

Parameters
Google_Job$postBody
array$optParamsOptional parameters.

@opt_param string onBehalfOfContentOwner 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).

Return values
Google_Service_YouTubeReporting_Job

◆ delete()

Google_Service_YouTubeReporting_Jobs_Resource::delete ( $jobId,
$optParams = array() )

Deletes a job.

(jobs.delete)

Parameters
string$jobIdThe ID of the job to delete.
array$optParamsOptional parameters.

@opt_param string onBehalfOfContentOwner 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).

Return values
Google_Service_YouTubeReporting_Empty

◆ get()

Google_Service_YouTubeReporting_Jobs_Resource::get ( $jobId,
$optParams = array() )

Gets a job.

(jobs.get)

Parameters
string$jobIdThe ID of the job to retrieve.
array$optParamsOptional parameters.

@opt_param string onBehalfOfContentOwner 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).

Return values
Google_Service_YouTubeReporting_Job

◆ listJobs()

Google_Service_YouTubeReporting_Jobs_Resource::listJobs ( $optParams = array())

Lists jobs.

(jobs.listJobs)

Parameters
array$optParamsOptional parameters.

@opt_param string pageToken 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. @opt_param string onBehalfOfContentOwner 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). @opt_param int pageSize Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.

Return values
Google_Service_YouTubeReporting_ListJobsResponse

The documentation for this class was generated from the following file: