Documentation

Google_Service_YouTube_Resource_Videos extends Google_Service_Resource
in package

Application

The "videos" collection of methods.

Typical usage is: $youtubeService = new Google_Service_YouTube(...); $videos = $youtubeService->videos;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Deletes a resource. (videos.delete)
getRating() : Google_Service_YouTube_VideoRatingListResponse: Retrieves the ratings that the authorized user gave to a list of specified videos. (videos.getRating)
insert() : Google_Service_YouTube_Video: Inserts a new resource into this collection. (videos.insert)
listVideos() : Google_Service_YouTube_VideoListResponse: Retrieves a list of resources, possibly filtered. (videos.listVideos)
rate() : mixed: Adds a like or dislike rating to a video or removes a rating from a video.
reportAbuse() : mixed: Report abuse for a video. (videos.reportAbuse)
update() : Google_Service_YouTube_Video: Updates an existing resource. (videos.update)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes a resource. (videos.delete)


    public
                delete(string $id[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$id : string
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

getRating()

Retrieves the ratings that the authorized user gave to a list of specified videos. (videos.getRating)


    public
                getRating(string|array<string|int, mixed> $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_VideoRatingListResponse

Parameters

$id : string|array<string|int, mixed>
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_VideoRatingListResponse —

insert()

Inserts a new resource into this collection. (videos.insert)


    public
                insert(string|array<string|int, mixed> $part, Google_Service_YouTube_Video $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_Video

Parameters

$part : string|array<string|int, mixed>: The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.
$postBody : Google_Service_YouTube_Video
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_Video —

listVideos()

Retrieves a list of resources, possibly filtered. (videos.listVideos)


    public
                listVideos(string|array<string|int, mixed> $part[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_VideoListResponse

Parameters

$part : string|array<string|int, mixed>: The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_VideoListResponse —

rate()

Adds a like or dislike rating to a video or removes a rating from a video.


    public
                rate(string $id, string $rating[, array<string|int, mixed> $optParams = array() ]) : mixed

(videos.rate)

Parameters

$id : string
$rating : string
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

reportAbuse()

Report abuse for a video. (videos.reportAbuse)


    public
                reportAbuse(Google_Service_YouTube_VideoAbuseReport $postBody[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$postBody : Google_Service_YouTube_VideoAbuseReport
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

update()

Updates an existing resource. (videos.update)


    public
                update(string|array<string|int, mixed> $part, Google_Service_YouTube_Video $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_Video

Parameters

$part : string|array<string|int, mixed>: The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting. In addition, not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.
$postBody : Google_Service_YouTube_Video
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_Video —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —