Viewing file:  PlaylistItems.php (8.09 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
/**
* The "playlistItems" collection of methods.
* Typical usage is:
* <code>
* $youtubeService = new Google_Service_YouTube(...);
* $playlistItems = $youtubeService->playlistItems;
* </code>
*/
class Google_Service_YouTube_Resource_PlaylistItems extends Google_Service_Resource
{
/**
* Deletes a resource. (playlistItems.delete)
*
* @param string $id
* @param array $optParams Optional parameters.
*
* @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwner*
* parameter indicates that the request's authorization credentials identify a
* YouTube CMS user who is acting on behalf of the content owner specified in
* the parameter value. This parameter is intended for YouTube content partners
* that own and manage many different YouTube channels. It allows content owners
* to authenticate once and get access to all their video and channel data,
* without having to provide authentication credentials for each individual
* channel. The CMS account that the user authenticates with must be linked to
* the specified YouTube content owner.
*/
public function delete($id, $optParams = array())
{
$params = array('id' => $id);
$params = array_merge($params, $optParams);
return $this->call('delete', array($params));
}
/**
* Inserts a new resource into this collection. (playlistItems.insert)
*
* @param string|array $part 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.
* @param Google_Service_YouTube_PlaylistItem $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwner*
* parameter indicates that the request's authorization credentials identify a
* YouTube CMS user who is acting on behalf of the content owner specified in
* the parameter value. This parameter is intended for YouTube content partners
* that own and manage many different YouTube channels. It allows content owners
* to authenticate once and get access to all their video and channel data,
* without having to provide authentication credentials for each individual
* channel. The CMS account that the user authenticates with must be linked to
* the specified YouTube content owner.
* @return Google_Service_YouTube_PlaylistItem
*/
public function insert($part, Google_Service_YouTube_PlaylistItem $postBody, $optParams = array())
{
$params = array('part' => $part, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('insert', array($params), "Google_Service_YouTube_PlaylistItem");
}
/**
* Retrieves a list of resources, possibly filtered.
* (playlistItems.listPlaylistItems)
*
* @param string|array $part The *part* parameter specifies a comma-separated
* list of one or more playlistItem 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 playlistItem resource, the snippet property contains numerous
* fields, including the title, description, position, and resourceId
* properties. As such, if you set *part=snippet*, the API response will contain
* all of those properties.
* @param array $optParams Optional parameters.
*
* @opt_param string id
* @opt_param string maxResults The *maxResults* parameter specifies the maximum
* number of items that should be returned in the result set.
* @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwner*
* parameter indicates that the request's authorization credentials identify a
* YouTube CMS user who is acting on behalf of the content owner specified in
* the parameter value. This parameter is intended for YouTube content partners
* that own and manage many different YouTube channels. It allows content owners
* to authenticate once and get access to all their video and channel data,
* without having to provide authentication credentials for each individual
* channel. The CMS account that the user authenticates with must be linked to
* the specified YouTube content owner.
* @opt_param string pageToken The *pageToken* parameter identifies a specific
* page in the result set that should be returned. In an API response, the
* nextPageToken and prevPageToken properties identify other pages that could be
* retrieved.
* @opt_param string playlistId Return the playlist items within the given
* playlist.
* @opt_param string videoId Return the playlist items associated with the given
* video ID.
* @return Google_Service_YouTube_PlaylistItemListResponse
*/
public function listPlaylistItems($part, $optParams = array())
{
$params = array('part' => $part);
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_YouTube_PlaylistItemListResponse");
}
/**
* Updates an existing resource. (playlistItems.update)
*
* @param string|array $part 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 playlist item can specify a start time and end time, which
* identify the times portion of the video that should play when users watch the
* video in the playlist. If your request is updating a playlist item that sets
* these values, and the request's part parameter value includes the
* contentDetails part, the playlist item's start and end times will be updated
* to whatever value the request body specifies. If the request body does not
* specify values, the existing start and end times will be removed and replaced
* with the default settings.
* @param Google_Service_YouTube_PlaylistItem $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwner*
* parameter indicates that the request's authorization credentials identify a
* YouTube CMS user who is acting on behalf of the content owner specified in
* the parameter value. This parameter is intended for YouTube content partners
* that own and manage many different YouTube channels. It allows content owners
* to authenticate once and get access to all their video and channel data,
* without having to provide authentication credentials for each individual
* channel. The CMS account that the user authenticates with must be linked to
* the specified YouTube content owner.
* @return Google_Service_YouTube_PlaylistItem
*/
public function update($part, Google_Service_YouTube_PlaylistItem $postBody, $optParams = array())
{
$params = array('part' => $part, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('update', array($params), "Google_Service_YouTube_PlaylistItem");
}
}
|