|
@@ 2069-2237 (lines=169) @@
|
| 2066 |
|
* $channelSections = $youtubeService->channelSections; |
| 2067 |
|
* </code> |
| 2068 |
|
*/ |
| 2069 |
|
class Google_Service_YouTube_ChannelSections_Resource extends Google_Service_Resource |
| 2070 |
|
{ |
| 2071 |
|
|
| 2072 |
|
/** |
| 2073 |
|
* Deletes a channelSection. (channelSections.delete) |
| 2074 |
|
* |
| 2075 |
|
* @param string $id The id parameter specifies the YouTube channelSection ID |
| 2076 |
|
* for the resource that is being deleted. In a channelSection resource, the id |
| 2077 |
|
* property specifies the YouTube channelSection ID. |
| 2078 |
|
* @param array $optParams Optional parameters. |
| 2079 |
|
* |
| 2080 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 2081 |
|
* exclusively for YouTube content partners. |
| 2082 |
|
* |
| 2083 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 2084 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 2085 |
|
* of the content owner specified in the parameter value. This parameter is |
| 2086 |
|
* intended for YouTube content partners that own and manage many different |
| 2087 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 2088 |
|
* access to all their video and channel data, without having to provide |
| 2089 |
|
* authentication credentials for each individual channel. The CMS account that |
| 2090 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 2091 |
|
* owner. |
| 2092 |
|
*/ |
| 2093 |
|
public function delete($id, $optParams = array()) |
| 2094 |
|
{ |
| 2095 |
|
$params = array('id' => $id); |
| 2096 |
|
$params = array_merge($params, $optParams); |
| 2097 |
|
return $this->call('delete', array($params)); |
| 2098 |
|
} |
| 2099 |
|
|
| 2100 |
|
/** |
| 2101 |
|
* Adds a channelSection for the authenticated user's channel. |
| 2102 |
|
* (channelSections.insert) |
| 2103 |
|
* |
| 2104 |
|
* @param string $part The part parameter serves two purposes in this operation. |
| 2105 |
|
* It identifies the properties that the write operation will set as well as the |
| 2106 |
|
* properties that the API response will include. |
| 2107 |
|
* |
| 2108 |
|
* The part names that you can include in the parameter value are snippet and |
| 2109 |
|
* contentDetails. |
| 2110 |
|
* @param Google_ChannelSection $postBody |
| 2111 |
|
* @param array $optParams Optional parameters. |
| 2112 |
|
* |
| 2113 |
|
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be |
| 2114 |
|
* used in a properly authorized request. Note: This parameter is intended |
| 2115 |
|
* exclusively for YouTube content partners. |
| 2116 |
|
* |
| 2117 |
|
* The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID |
| 2118 |
|
* of the channel to which a video is being added. This parameter is required |
| 2119 |
|
* when a request specifies a value for the onBehalfOfContentOwner parameter, |
| 2120 |
|
* and it can only be used in conjunction with that parameter. In addition, the |
| 2121 |
|
* request must be authorized using a CMS account that is linked to the content |
| 2122 |
|
* owner that the onBehalfOfContentOwner parameter specifies. Finally, the |
| 2123 |
|
* channel that the onBehalfOfContentOwnerChannel parameter value specifies must |
| 2124 |
|
* be linked to the content owner that the onBehalfOfContentOwner parameter |
| 2125 |
|
* specifies. |
| 2126 |
|
* |
| 2127 |
|
* This parameter is intended for YouTube content partners that own and manage |
| 2128 |
|
* many different YouTube channels. It allows content owners to authenticate |
| 2129 |
|
* once and perform actions on behalf of the channel specified in the parameter |
| 2130 |
|
* value, without having to provide authentication credentials for each separate |
| 2131 |
|
* channel. |
| 2132 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 2133 |
|
* exclusively for YouTube content partners. |
| 2134 |
|
* |
| 2135 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 2136 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 2137 |
|
* of the content owner specified in the parameter value. This parameter is |
| 2138 |
|
* intended for YouTube content partners that own and manage many different |
| 2139 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 2140 |
|
* access to all their video and channel data, without having to provide |
| 2141 |
|
* authentication credentials for each individual channel. The CMS account that |
| 2142 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 2143 |
|
* owner. |
| 2144 |
|
* @return Google_Service_YouTube_ChannelSection |
| 2145 |
|
*/ |
| 2146 |
|
public function insert($part, Google_Service_YouTube_ChannelSection $postBody, $optParams = array()) |
| 2147 |
|
{ |
| 2148 |
|
$params = array('part' => $part, 'postBody' => $postBody); |
| 2149 |
|
$params = array_merge($params, $optParams); |
| 2150 |
|
return $this->call('insert', array($params), "Google_Service_YouTube_ChannelSection"); |
| 2151 |
|
} |
| 2152 |
|
|
| 2153 |
|
/** |
| 2154 |
|
* Returns channelSection resources that match the API request criteria. |
| 2155 |
|
* (channelSections.listChannelSections) |
| 2156 |
|
* |
| 2157 |
|
* @param string $part The part parameter specifies a comma-separated list of |
| 2158 |
|
* one or more channelSection resource properties that the API response will |
| 2159 |
|
* include. The part names that you can include in the parameter value are id, |
| 2160 |
|
* snippet, and contentDetails. |
| 2161 |
|
* |
| 2162 |
|
* If the parameter identifies a property that contains child properties, the |
| 2163 |
|
* child properties will be included in the response. For example, in a |
| 2164 |
|
* channelSection resource, the snippet property contains other properties, such |
| 2165 |
|
* as a display title for the channelSection. If you set part=snippet, the API |
| 2166 |
|
* response will also contain all of those nested properties. |
| 2167 |
|
* @param array $optParams Optional parameters. |
| 2168 |
|
* |
| 2169 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 2170 |
|
* exclusively for YouTube content partners. |
| 2171 |
|
* |
| 2172 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 2173 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 2174 |
|
* of the content owner specified in the parameter value. This parameter is |
| 2175 |
|
* intended for YouTube content partners that own and manage many different |
| 2176 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 2177 |
|
* access to all their video and channel data, without having to provide |
| 2178 |
|
* authentication credentials for each individual channel. The CMS account that |
| 2179 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 2180 |
|
* owner. |
| 2181 |
|
* @opt_param string channelId The channelId parameter specifies a YouTube |
| 2182 |
|
* channel ID. The API will only return that channel's channelSections. |
| 2183 |
|
* @opt_param bool mine Set this parameter's value to true to retrieve a feed of |
| 2184 |
|
* the authenticated user's channelSections. |
| 2185 |
|
* @opt_param string hl The hl parameter indicates that the snippet.localized |
| 2186 |
|
* property values in the returned channelSection resources should be in the |
| 2187 |
|
* specified language if localized values for that language are available. For |
| 2188 |
|
* example, if the API request specifies hl=de, the snippet.localized properties |
| 2189 |
|
* in the API response will contain German titles if German titles are |
| 2190 |
|
* available. Channel owners can provide localized channel section titles using |
| 2191 |
|
* either the channelSections.insert or channelSections.update method. |
| 2192 |
|
* @opt_param string id The id parameter specifies a comma-separated list of the |
| 2193 |
|
* YouTube channelSection ID(s) for the resource(s) that are being retrieved. In |
| 2194 |
|
* a channelSection resource, the id property specifies the YouTube |
| 2195 |
|
* channelSection ID. |
| 2196 |
|
* @return Google_Service_YouTube_ChannelSectionListResponse |
| 2197 |
|
*/ |
| 2198 |
|
public function listChannelSections($part, $optParams = array()) |
| 2199 |
|
{ |
| 2200 |
|
$params = array('part' => $part); |
| 2201 |
|
$params = array_merge($params, $optParams); |
| 2202 |
|
return $this->call('list', array($params), "Google_Service_YouTube_ChannelSectionListResponse"); |
| 2203 |
|
} |
| 2204 |
|
|
| 2205 |
|
/** |
| 2206 |
|
* Update a channelSection. (channelSections.update) |
| 2207 |
|
* |
| 2208 |
|
* @param string $part The part parameter serves two purposes in this operation. |
| 2209 |
|
* It identifies the properties that the write operation will set as well as the |
| 2210 |
|
* properties that the API response will include. |
| 2211 |
|
* |
| 2212 |
|
* The part names that you can include in the parameter value are snippet and |
| 2213 |
|
* contentDetails. |
| 2214 |
|
* @param Google_ChannelSection $postBody |
| 2215 |
|
* @param array $optParams Optional parameters. |
| 2216 |
|
* |
| 2217 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 2218 |
|
* exclusively for YouTube content partners. |
| 2219 |
|
* |
| 2220 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 2221 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 2222 |
|
* of the content owner specified in the parameter value. This parameter is |
| 2223 |
|
* intended for YouTube content partners that own and manage many different |
| 2224 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 2225 |
|
* access to all their video and channel data, without having to provide |
| 2226 |
|
* authentication credentials for each individual channel. The CMS account that |
| 2227 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 2228 |
|
* owner. |
| 2229 |
|
* @return Google_Service_YouTube_ChannelSection |
| 2230 |
|
*/ |
| 2231 |
|
public function update($part, Google_Service_YouTube_ChannelSection $postBody, $optParams = array()) |
| 2232 |
|
{ |
| 2233 |
|
$params = array('part' => $part, 'postBody' => $postBody); |
| 2234 |
|
$params = array_merge($params, $optParams); |
| 2235 |
|
return $this->call('update', array($params), "Google_Service_YouTube_ChannelSection"); |
| 2236 |
|
} |
| 2237 |
|
} |
| 2238 |
|
|
| 2239 |
|
/** |
| 2240 |
|
* The "channels" collection of methods. |
|
@@ 3141-3363 (lines=223) @@
|
| 3138 |
|
* $liveStreams = $youtubeService->liveStreams; |
| 3139 |
|
* </code> |
| 3140 |
|
*/ |
| 3141 |
|
class Google_Service_YouTube_LiveStreams_Resource extends Google_Service_Resource |
| 3142 |
|
{ |
| 3143 |
|
|
| 3144 |
|
/** |
| 3145 |
|
* Deletes a video stream. (liveStreams.delete) |
| 3146 |
|
* |
| 3147 |
|
* @param string $id The id parameter specifies the YouTube live stream ID for |
| 3148 |
|
* the resource that is being deleted. |
| 3149 |
|
* @param array $optParams Optional parameters. |
| 3150 |
|
* |
| 3151 |
|
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be |
| 3152 |
|
* used in a properly authorized request. Note: This parameter is intended |
| 3153 |
|
* exclusively for YouTube content partners. |
| 3154 |
|
* |
| 3155 |
|
* The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID |
| 3156 |
|
* of the channel to which a video is being added. This parameter is required |
| 3157 |
|
* when a request specifies a value for the onBehalfOfContentOwner parameter, |
| 3158 |
|
* and it can only be used in conjunction with that parameter. In addition, the |
| 3159 |
|
* request must be authorized using a CMS account that is linked to the content |
| 3160 |
|
* owner that the onBehalfOfContentOwner parameter specifies. Finally, the |
| 3161 |
|
* channel that the onBehalfOfContentOwnerChannel parameter value specifies must |
| 3162 |
|
* be linked to the content owner that the onBehalfOfContentOwner parameter |
| 3163 |
|
* specifies. |
| 3164 |
|
* |
| 3165 |
|
* This parameter is intended for YouTube content partners that own and manage |
| 3166 |
|
* many different YouTube channels. It allows content owners to authenticate |
| 3167 |
|
* once and perform actions on behalf of the channel specified in the parameter |
| 3168 |
|
* value, without having to provide authentication credentials for each separate |
| 3169 |
|
* channel. |
| 3170 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 3171 |
|
* exclusively for YouTube content partners. |
| 3172 |
|
* |
| 3173 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 3174 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 3175 |
|
* of the content owner specified in the parameter value. This parameter is |
| 3176 |
|
* intended for YouTube content partners that own and manage many different |
| 3177 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 3178 |
|
* access to all their video and channel data, without having to provide |
| 3179 |
|
* authentication credentials for each individual channel. The CMS account that |
| 3180 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 3181 |
|
* owner. |
| 3182 |
|
*/ |
| 3183 |
|
public function delete($id, $optParams = array()) |
| 3184 |
|
{ |
| 3185 |
|
$params = array('id' => $id); |
| 3186 |
|
$params = array_merge($params, $optParams); |
| 3187 |
|
return $this->call('delete', array($params)); |
| 3188 |
|
} |
| 3189 |
|
|
| 3190 |
|
/** |
| 3191 |
|
* Creates a video stream. The stream enables you to send your video to YouTube, |
| 3192 |
|
* which can then broadcast the video to your audience. (liveStreams.insert) |
| 3193 |
|
* |
| 3194 |
|
* @param string $part The part parameter serves two purposes in this operation. |
| 3195 |
|
* It identifies the properties that the write operation will set as well as the |
| 3196 |
|
* properties that the API response will include. |
| 3197 |
|
* |
| 3198 |
|
* The part properties that you can include in the parameter value are id, |
| 3199 |
|
* snippet, cdn, and status. |
| 3200 |
|
* @param Google_LiveStream $postBody |
| 3201 |
|
* @param array $optParams Optional parameters. |
| 3202 |
|
* |
| 3203 |
|
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be |
| 3204 |
|
* used in a properly authorized request. Note: This parameter is intended |
| 3205 |
|
* exclusively for YouTube content partners. |
| 3206 |
|
* |
| 3207 |
|
* The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID |
| 3208 |
|
* of the channel to which a video is being added. This parameter is required |
| 3209 |
|
* when a request specifies a value for the onBehalfOfContentOwner parameter, |
| 3210 |
|
* and it can only be used in conjunction with that parameter. In addition, the |
| 3211 |
|
* request must be authorized using a CMS account that is linked to the content |
| 3212 |
|
* owner that the onBehalfOfContentOwner parameter specifies. Finally, the |
| 3213 |
|
* channel that the onBehalfOfContentOwnerChannel parameter value specifies must |
| 3214 |
|
* be linked to the content owner that the onBehalfOfContentOwner parameter |
| 3215 |
|
* specifies. |
| 3216 |
|
* |
| 3217 |
|
* This parameter is intended for YouTube content partners that own and manage |
| 3218 |
|
* many different YouTube channels. It allows content owners to authenticate |
| 3219 |
|
* once and perform actions on behalf of the channel specified in the parameter |
| 3220 |
|
* value, without having to provide authentication credentials for each separate |
| 3221 |
|
* channel. |
| 3222 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 3223 |
|
* exclusively for YouTube content partners. |
| 3224 |
|
* |
| 3225 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 3226 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 3227 |
|
* of the content owner specified in the parameter value. This parameter is |
| 3228 |
|
* intended for YouTube content partners that own and manage many different |
| 3229 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 3230 |
|
* access to all their video and channel data, without having to provide |
| 3231 |
|
* authentication credentials for each individual channel. The CMS account that |
| 3232 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 3233 |
|
* owner. |
| 3234 |
|
* @return Google_Service_YouTube_LiveStream |
| 3235 |
|
*/ |
| 3236 |
|
public function insert($part, Google_Service_YouTube_LiveStream $postBody, $optParams = array()) |
| 3237 |
|
{ |
| 3238 |
|
$params = array('part' => $part, 'postBody' => $postBody); |
| 3239 |
|
$params = array_merge($params, $optParams); |
| 3240 |
|
return $this->call('insert', array($params), "Google_Service_YouTube_LiveStream"); |
| 3241 |
|
} |
| 3242 |
|
|
| 3243 |
|
/** |
| 3244 |
|
* Returns a list of video streams that match the API request parameters. |
| 3245 |
|
* (liveStreams.listLiveStreams) |
| 3246 |
|
* |
| 3247 |
|
* @param string $part The part parameter specifies a comma-separated list of |
| 3248 |
|
* one or more liveStream resource properties that the API response will |
| 3249 |
|
* include. The part names that you can include in the parameter value are id, |
| 3250 |
|
* snippet, cdn, and status. |
| 3251 |
|
* @param array $optParams Optional parameters. |
| 3252 |
|
* |
| 3253 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 3254 |
|
* exclusively for YouTube content partners. |
| 3255 |
|
* |
| 3256 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 3257 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 3258 |
|
* of the content owner specified in the parameter value. This parameter is |
| 3259 |
|
* intended for YouTube content partners that own and manage many different |
| 3260 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 3261 |
|
* access to all their video and channel data, without having to provide |
| 3262 |
|
* authentication credentials for each individual channel. The CMS account that |
| 3263 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 3264 |
|
* owner. |
| 3265 |
|
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be |
| 3266 |
|
* used in a properly authorized request. Note: This parameter is intended |
| 3267 |
|
* exclusively for YouTube content partners. |
| 3268 |
|
* |
| 3269 |
|
* The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID |
| 3270 |
|
* of the channel to which a video is being added. This parameter is required |
| 3271 |
|
* when a request specifies a value for the onBehalfOfContentOwner parameter, |
| 3272 |
|
* and it can only be used in conjunction with that parameter. In addition, the |
| 3273 |
|
* request must be authorized using a CMS account that is linked to the content |
| 3274 |
|
* owner that the onBehalfOfContentOwner parameter specifies. Finally, the |
| 3275 |
|
* channel that the onBehalfOfContentOwnerChannel parameter value specifies must |
| 3276 |
|
* be linked to the content owner that the onBehalfOfContentOwner parameter |
| 3277 |
|
* specifies. |
| 3278 |
|
* |
| 3279 |
|
* This parameter is intended for YouTube content partners that own and manage |
| 3280 |
|
* many different YouTube channels. It allows content owners to authenticate |
| 3281 |
|
* once and perform actions on behalf of the channel specified in the parameter |
| 3282 |
|
* value, without having to provide authentication credentials for each separate |
| 3283 |
|
* channel. |
| 3284 |
|
* @opt_param bool mine The mine parameter can be used to instruct the API to |
| 3285 |
|
* only return streams owned by the authenticated user. Set the parameter value |
| 3286 |
|
* to true to only retrieve your own streams. |
| 3287 |
|
* @opt_param string maxResults The maxResults parameter specifies the maximum |
| 3288 |
|
* number of items that should be returned in the result set. |
| 3289 |
|
* @opt_param string pageToken The pageToken parameter identifies a specific |
| 3290 |
|
* page in the result set that should be returned. In an API response, the |
| 3291 |
|
* nextPageToken and prevPageToken properties identify other pages that could be |
| 3292 |
|
* retrieved. |
| 3293 |
|
* @opt_param string id The id parameter specifies a comma-separated list of |
| 3294 |
|
* YouTube stream IDs that identify the streams being retrieved. In a liveStream |
| 3295 |
|
* resource, the id property specifies the stream's ID. |
| 3296 |
|
* @return Google_Service_YouTube_LiveStreamListResponse |
| 3297 |
|
*/ |
| 3298 |
|
public function listLiveStreams($part, $optParams = array()) |
| 3299 |
|
{ |
| 3300 |
|
$params = array('part' => $part); |
| 3301 |
|
$params = array_merge($params, $optParams); |
| 3302 |
|
return $this->call('list', array($params), "Google_Service_YouTube_LiveStreamListResponse"); |
| 3303 |
|
} |
| 3304 |
|
|
| 3305 |
|
/** |
| 3306 |
|
* Updates a video stream. If the properties that you want to change cannot be |
| 3307 |
|
* updated, then you need to create a new stream with the proper settings. |
| 3308 |
|
* (liveStreams.update) |
| 3309 |
|
* |
| 3310 |
|
* @param string $part The part parameter serves two purposes in this operation. |
| 3311 |
|
* It identifies the properties that the write operation will set as well as the |
| 3312 |
|
* properties that the API response will include. |
| 3313 |
|
* |
| 3314 |
|
* The part properties that you can include in the parameter value are id, |
| 3315 |
|
* snippet, cdn, and status. |
| 3316 |
|
* |
| 3317 |
|
* Note that this method will override the existing values for all of the |
| 3318 |
|
* mutable properties that are contained in any parts that the parameter value |
| 3319 |
|
* specifies. If the request body does not specify a value for a mutable |
| 3320 |
|
* property, the existing value for that property will be removed. |
| 3321 |
|
* @param Google_LiveStream $postBody |
| 3322 |
|
* @param array $optParams Optional parameters. |
| 3323 |
|
* |
| 3324 |
|
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be |
| 3325 |
|
* used in a properly authorized request. Note: This parameter is intended |
| 3326 |
|
* exclusively for YouTube content partners. |
| 3327 |
|
* |
| 3328 |
|
* The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID |
| 3329 |
|
* of the channel to which a video is being added. This parameter is required |
| 3330 |
|
* when a request specifies a value for the onBehalfOfContentOwner parameter, |
| 3331 |
|
* and it can only be used in conjunction with that parameter. In addition, the |
| 3332 |
|
* request must be authorized using a CMS account that is linked to the content |
| 3333 |
|
* owner that the onBehalfOfContentOwner parameter specifies. Finally, the |
| 3334 |
|
* channel that the onBehalfOfContentOwnerChannel parameter value specifies must |
| 3335 |
|
* be linked to the content owner that the onBehalfOfContentOwner parameter |
| 3336 |
|
* specifies. |
| 3337 |
|
* |
| 3338 |
|
* This parameter is intended for YouTube content partners that own and manage |
| 3339 |
|
* many different YouTube channels. It allows content owners to authenticate |
| 3340 |
|
* once and perform actions on behalf of the channel specified in the parameter |
| 3341 |
|
* value, without having to provide authentication credentials for each separate |
| 3342 |
|
* channel. |
| 3343 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 3344 |
|
* exclusively for YouTube content partners. |
| 3345 |
|
* |
| 3346 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 3347 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 3348 |
|
* of the content owner specified in the parameter value. This parameter is |
| 3349 |
|
* intended for YouTube content partners that own and manage many different |
| 3350 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 3351 |
|
* access to all their video and channel data, without having to provide |
| 3352 |
|
* authentication credentials for each individual channel. The CMS account that |
| 3353 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 3354 |
|
* owner. |
| 3355 |
|
* @return Google_Service_YouTube_LiveStream |
| 3356 |
|
*/ |
| 3357 |
|
public function update($part, Google_Service_YouTube_LiveStream $postBody, $optParams = array()) |
| 3358 |
|
{ |
| 3359 |
|
$params = array('part' => $part, 'postBody' => $postBody); |
| 3360 |
|
$params = array_merge($params, $optParams); |
| 3361 |
|
return $this->call('update', array($params), "Google_Service_YouTube_LiveStream"); |
| 3362 |
|
} |
| 3363 |
|
} |
| 3364 |
|
|
| 3365 |
|
/** |
| 3366 |
|
* The "playlistItems" collection of methods. |
|
@@ 3373-3503 (lines=131) @@
|
| 3370 |
|
* $playlistItems = $youtubeService->playlistItems; |
| 3371 |
|
* </code> |
| 3372 |
|
*/ |
| 3373 |
|
class Google_Service_YouTube_PlaylistItems_Resource extends Google_Service_Resource |
| 3374 |
|
{ |
| 3375 |
|
|
| 3376 |
|
/** |
| 3377 |
|
* Deletes a playlist item. (playlistItems.delete) |
| 3378 |
|
* |
| 3379 |
|
* @param string $id The id parameter specifies the YouTube playlist item ID for |
| 3380 |
|
* the playlist item that is being deleted. In a playlistItem resource, the id |
| 3381 |
|
* property specifies the playlist item's ID. |
| 3382 |
|
* @param array $optParams Optional parameters. |
| 3383 |
|
*/ |
| 3384 |
|
public function delete($id, $optParams = array()) |
| 3385 |
|
{ |
| 3386 |
|
$params = array('id' => $id); |
| 3387 |
|
$params = array_merge($params, $optParams); |
| 3388 |
|
return $this->call('delete', array($params)); |
| 3389 |
|
} |
| 3390 |
|
|
| 3391 |
|
/** |
| 3392 |
|
* Adds a resource to a playlist. (playlistItems.insert) |
| 3393 |
|
* |
| 3394 |
|
* @param string $part The part parameter serves two purposes in this operation. |
| 3395 |
|
* It identifies the properties that the write operation will set as well as the |
| 3396 |
|
* properties that the API response will include. |
| 3397 |
|
* @param Google_PlaylistItem $postBody |
| 3398 |
|
* @param array $optParams Optional parameters. |
| 3399 |
|
* |
| 3400 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 3401 |
|
* exclusively for YouTube content partners. |
| 3402 |
|
* |
| 3403 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 3404 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 3405 |
|
* of the content owner specified in the parameter value. This parameter is |
| 3406 |
|
* intended for YouTube content partners that own and manage many different |
| 3407 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 3408 |
|
* access to all their video and channel data, without having to provide |
| 3409 |
|
* authentication credentials for each individual channel. The CMS account that |
| 3410 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 3411 |
|
* owner. |
| 3412 |
|
* @return Google_Service_YouTube_PlaylistItem |
| 3413 |
|
*/ |
| 3414 |
|
public function insert($part, Google_Service_YouTube_PlaylistItem $postBody, $optParams = array()) |
| 3415 |
|
{ |
| 3416 |
|
$params = array('part' => $part, 'postBody' => $postBody); |
| 3417 |
|
$params = array_merge($params, $optParams); |
| 3418 |
|
return $this->call('insert', array($params), "Google_Service_YouTube_PlaylistItem"); |
| 3419 |
|
} |
| 3420 |
|
|
| 3421 |
|
/** |
| 3422 |
|
* Returns a collection of playlist items that match the API request parameters. |
| 3423 |
|
* You can retrieve all of the playlist items in a specified playlist or |
| 3424 |
|
* retrieve one or more playlist items by their unique IDs. |
| 3425 |
|
* (playlistItems.listPlaylistItems) |
| 3426 |
|
* |
| 3427 |
|
* @param string $part The part parameter specifies a comma-separated list of |
| 3428 |
|
* one or more playlistItem resource properties that the API response will |
| 3429 |
|
* include. |
| 3430 |
|
* |
| 3431 |
|
* If the parameter identifies a property that contains child properties, the |
| 3432 |
|
* child properties will be included in the response. For example, in a |
| 3433 |
|
* playlistItem resource, the snippet property contains numerous fields, |
| 3434 |
|
* including the title, description, position, and resourceId properties. As |
| 3435 |
|
* such, if you set part=snippet, the API response will contain all of those |
| 3436 |
|
* properties. |
| 3437 |
|
* @param array $optParams Optional parameters. |
| 3438 |
|
* |
| 3439 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 3440 |
|
* exclusively for YouTube content partners. |
| 3441 |
|
* |
| 3442 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 3443 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 3444 |
|
* of the content owner specified in the parameter value. This parameter is |
| 3445 |
|
* intended for YouTube content partners that own and manage many different |
| 3446 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 3447 |
|
* access to all their video and channel data, without having to provide |
| 3448 |
|
* authentication credentials for each individual channel. The CMS account that |
| 3449 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 3450 |
|
* owner. |
| 3451 |
|
* @opt_param string playlistId The playlistId parameter specifies the unique ID |
| 3452 |
|
* of the playlist for which you want to retrieve playlist items. Note that even |
| 3453 |
|
* though this is an optional parameter, every request to retrieve playlist |
| 3454 |
|
* items must specify a value for either the id parameter or the playlistId |
| 3455 |
|
* parameter. |
| 3456 |
|
* @opt_param string videoId The videoId parameter specifies that the request |
| 3457 |
|
* should return only the playlist items that contain the specified video. |
| 3458 |
|
* @opt_param string maxResults The maxResults parameter specifies the maximum |
| 3459 |
|
* number of items that should be returned in the result set. |
| 3460 |
|
* @opt_param string pageToken The pageToken parameter identifies a specific |
| 3461 |
|
* page in the result set that should be returned. In an API response, the |
| 3462 |
|
* nextPageToken and prevPageToken properties identify other pages that could be |
| 3463 |
|
* retrieved. |
| 3464 |
|
* @opt_param string id The id parameter specifies a comma-separated list of one |
| 3465 |
|
* or more unique playlist item IDs. |
| 3466 |
|
* @return Google_Service_YouTube_PlaylistItemListResponse |
| 3467 |
|
*/ |
| 3468 |
|
public function listPlaylistItems($part, $optParams = array()) |
| 3469 |
|
{ |
| 3470 |
|
$params = array('part' => $part); |
| 3471 |
|
$params = array_merge($params, $optParams); |
| 3472 |
|
return $this->call('list', array($params), "Google_Service_YouTube_PlaylistItemListResponse"); |
| 3473 |
|
} |
| 3474 |
|
|
| 3475 |
|
/** |
| 3476 |
|
* Modifies a playlist item. For example, you could update the item's position |
| 3477 |
|
* in the playlist. (playlistItems.update) |
| 3478 |
|
* |
| 3479 |
|
* @param string $part The part parameter serves two purposes in this operation. |
| 3480 |
|
* It identifies the properties that the write operation will set as well as the |
| 3481 |
|
* properties that the API response will include. |
| 3482 |
|
* |
| 3483 |
|
* Note that this method will override the existing values for all of the |
| 3484 |
|
* mutable properties that are contained in any parts that the parameter value |
| 3485 |
|
* specifies. For example, a playlist item can specify a start time and end |
| 3486 |
|
* time, which identify the times portion of the video that should play when |
| 3487 |
|
* users watch the video in the playlist. If your request is updating a playlist |
| 3488 |
|
* item that sets these values, and the request's part parameter value includes |
| 3489 |
|
* the contentDetails part, the playlist item's start and end times will be |
| 3490 |
|
* updated to whatever value the request body specifies. If the request body |
| 3491 |
|
* does not specify values, the existing start and end times will be removed and |
| 3492 |
|
* replaced with the default settings. |
| 3493 |
|
* @param Google_PlaylistItem $postBody |
| 3494 |
|
* @param array $optParams Optional parameters. |
| 3495 |
|
* @return Google_Service_YouTube_PlaylistItem |
| 3496 |
|
*/ |
| 3497 |
|
public function update($part, Google_Service_YouTube_PlaylistItem $postBody, $optParams = array()) |
| 3498 |
|
{ |
| 3499 |
|
$params = array('part' => $part, 'postBody' => $postBody); |
| 3500 |
|
$params = array_merge($params, $optParams); |
| 3501 |
|
return $this->call('update', array($params), "Google_Service_YouTube_PlaylistItem"); |
| 3502 |
|
} |
| 3503 |
|
} |
| 3504 |
|
|
| 3505 |
|
/** |
| 3506 |
|
* The "playlists" collection of methods. |
|
@@ 3513-3702 (lines=190) @@
|
| 3510 |
|
* $playlists = $youtubeService->playlists; |
| 3511 |
|
* </code> |
| 3512 |
|
*/ |
| 3513 |
|
class Google_Service_YouTube_Playlists_Resource extends Google_Service_Resource |
| 3514 |
|
{ |
| 3515 |
|
|
| 3516 |
|
/** |
| 3517 |
|
* Deletes a playlist. (playlists.delete) |
| 3518 |
|
* |
| 3519 |
|
* @param string $id The id parameter specifies the YouTube playlist ID for the |
| 3520 |
|
* playlist that is being deleted. In a playlist resource, the id property |
| 3521 |
|
* specifies the playlist's ID. |
| 3522 |
|
* @param array $optParams Optional parameters. |
| 3523 |
|
* |
| 3524 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 3525 |
|
* exclusively for YouTube content partners. |
| 3526 |
|
* |
| 3527 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 3528 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 3529 |
|
* of the content owner specified in the parameter value. This parameter is |
| 3530 |
|
* intended for YouTube content partners that own and manage many different |
| 3531 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 3532 |
|
* access to all their video and channel data, without having to provide |
| 3533 |
|
* authentication credentials for each individual channel. The CMS account that |
| 3534 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 3535 |
|
* owner. |
| 3536 |
|
*/ |
| 3537 |
|
public function delete($id, $optParams = array()) |
| 3538 |
|
{ |
| 3539 |
|
$params = array('id' => $id); |
| 3540 |
|
$params = array_merge($params, $optParams); |
| 3541 |
|
return $this->call('delete', array($params)); |
| 3542 |
|
} |
| 3543 |
|
|
| 3544 |
|
/** |
| 3545 |
|
* Creates a playlist. (playlists.insert) |
| 3546 |
|
* |
| 3547 |
|
* @param string $part The part parameter serves two purposes in this operation. |
| 3548 |
|
* It identifies the properties that the write operation will set as well as the |
| 3549 |
|
* properties that the API response will include. |
| 3550 |
|
* @param Google_Playlist $postBody |
| 3551 |
|
* @param array $optParams Optional parameters. |
| 3552 |
|
* |
| 3553 |
|
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be |
| 3554 |
|
* used in a properly authorized request. Note: This parameter is intended |
| 3555 |
|
* exclusively for YouTube content partners. |
| 3556 |
|
* |
| 3557 |
|
* The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID |
| 3558 |
|
* of the channel to which a video is being added. This parameter is required |
| 3559 |
|
* when a request specifies a value for the onBehalfOfContentOwner parameter, |
| 3560 |
|
* and it can only be used in conjunction with that parameter. In addition, the |
| 3561 |
|
* request must be authorized using a CMS account that is linked to the content |
| 3562 |
|
* owner that the onBehalfOfContentOwner parameter specifies. Finally, the |
| 3563 |
|
* channel that the onBehalfOfContentOwnerChannel parameter value specifies must |
| 3564 |
|
* be linked to the content owner that the onBehalfOfContentOwner parameter |
| 3565 |
|
* specifies. |
| 3566 |
|
* |
| 3567 |
|
* This parameter is intended for YouTube content partners that own and manage |
| 3568 |
|
* many different YouTube channels. It allows content owners to authenticate |
| 3569 |
|
* once and perform actions on behalf of the channel specified in the parameter |
| 3570 |
|
* value, without having to provide authentication credentials for each separate |
| 3571 |
|
* channel. |
| 3572 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 3573 |
|
* exclusively for YouTube content partners. |
| 3574 |
|
* |
| 3575 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 3576 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 3577 |
|
* of the content owner specified in the parameter value. This parameter is |
| 3578 |
|
* intended for YouTube content partners that own and manage many different |
| 3579 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 3580 |
|
* access to all their video and channel data, without having to provide |
| 3581 |
|
* authentication credentials for each individual channel. The CMS account that |
| 3582 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 3583 |
|
* owner. |
| 3584 |
|
* @return Google_Service_YouTube_Playlist |
| 3585 |
|
*/ |
| 3586 |
|
public function insert($part, Google_Service_YouTube_Playlist $postBody, $optParams = array()) |
| 3587 |
|
{ |
| 3588 |
|
$params = array('part' => $part, 'postBody' => $postBody); |
| 3589 |
|
$params = array_merge($params, $optParams); |
| 3590 |
|
return $this->call('insert', array($params), "Google_Service_YouTube_Playlist"); |
| 3591 |
|
} |
| 3592 |
|
|
| 3593 |
|
/** |
| 3594 |
|
* Returns a collection of playlists that match the API request parameters. For |
| 3595 |
|
* example, you can retrieve all playlists that the authenticated user owns, or |
| 3596 |
|
* you can retrieve one or more playlists by their unique IDs. |
| 3597 |
|
* (playlists.listPlaylists) |
| 3598 |
|
* |
| 3599 |
|
* @param string $part The part parameter specifies a comma-separated list of |
| 3600 |
|
* one or more playlist resource properties that the API response will include. |
| 3601 |
|
* |
| 3602 |
|
* If the parameter identifies a property that contains child properties, the |
| 3603 |
|
* child properties will be included in the response. For example, in a playlist |
| 3604 |
|
* resource, the snippet property contains properties like author, title, |
| 3605 |
|
* description, tags, and timeCreated. As such, if you set part=snippet, the API |
| 3606 |
|
* response will contain all of those properties. |
| 3607 |
|
* @param array $optParams Optional parameters. |
| 3608 |
|
* |
| 3609 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 3610 |
|
* exclusively for YouTube content partners. |
| 3611 |
|
* |
| 3612 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 3613 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 3614 |
|
* of the content owner specified in the parameter value. This parameter is |
| 3615 |
|
* intended for YouTube content partners that own and manage many different |
| 3616 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 3617 |
|
* access to all their video and channel data, without having to provide |
| 3618 |
|
* authentication credentials for each individual channel. The CMS account that |
| 3619 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 3620 |
|
* owner. |
| 3621 |
|
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be |
| 3622 |
|
* used in a properly authorized request. Note: This parameter is intended |
| 3623 |
|
* exclusively for YouTube content partners. |
| 3624 |
|
* |
| 3625 |
|
* The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID |
| 3626 |
|
* of the channel to which a video is being added. This parameter is required |
| 3627 |
|
* when a request specifies a value for the onBehalfOfContentOwner parameter, |
| 3628 |
|
* and it can only be used in conjunction with that parameter. In addition, the |
| 3629 |
|
* request must be authorized using a CMS account that is linked to the content |
| 3630 |
|
* owner that the onBehalfOfContentOwner parameter specifies. Finally, the |
| 3631 |
|
* channel that the onBehalfOfContentOwnerChannel parameter value specifies must |
| 3632 |
|
* be linked to the content owner that the onBehalfOfContentOwner parameter |
| 3633 |
|
* specifies. |
| 3634 |
|
* |
| 3635 |
|
* This parameter is intended for YouTube content partners that own and manage |
| 3636 |
|
* many different YouTube channels. It allows content owners to authenticate |
| 3637 |
|
* once and perform actions on behalf of the channel specified in the parameter |
| 3638 |
|
* value, without having to provide authentication credentials for each separate |
| 3639 |
|
* channel. |
| 3640 |
|
* @opt_param string channelId This value indicates that the API should only |
| 3641 |
|
* return the specified channel's playlists. |
| 3642 |
|
* @opt_param bool mine Set this parameter's value to true to instruct the API |
| 3643 |
|
* to only return playlists owned by the authenticated user. |
| 3644 |
|
* @opt_param string maxResults The maxResults parameter specifies the maximum |
| 3645 |
|
* number of items that should be returned in the result set. |
| 3646 |
|
* @opt_param string pageToken The pageToken parameter identifies a specific |
| 3647 |
|
* page in the result set that should be returned. In an API response, the |
| 3648 |
|
* nextPageToken and prevPageToken properties identify other pages that could be |
| 3649 |
|
* retrieved. |
| 3650 |
|
* @opt_param string hl The hl parameter should be used for filter out the |
| 3651 |
|
* properties that are not in the given language. Used for the snippet part. |
| 3652 |
|
* @opt_param string id The id parameter specifies a comma-separated list of the |
| 3653 |
|
* YouTube playlist ID(s) for the resource(s) that are being retrieved. In a |
| 3654 |
|
* playlist resource, the id property specifies the playlist's YouTube playlist |
| 3655 |
|
* ID. |
| 3656 |
|
* @return Google_Service_YouTube_PlaylistListResponse |
| 3657 |
|
*/ |
| 3658 |
|
public function listPlaylists($part, $optParams = array()) |
| 3659 |
|
{ |
| 3660 |
|
$params = array('part' => $part); |
| 3661 |
|
$params = array_merge($params, $optParams); |
| 3662 |
|
return $this->call('list', array($params), "Google_Service_YouTube_PlaylistListResponse"); |
| 3663 |
|
} |
| 3664 |
|
|
| 3665 |
|
/** |
| 3666 |
|
* Modifies a playlist. For example, you could change a playlist's title, |
| 3667 |
|
* description, or privacy status. (playlists.update) |
| 3668 |
|
* |
| 3669 |
|
* @param string $part The part parameter serves two purposes in this operation. |
| 3670 |
|
* It identifies the properties that the write operation will set as well as the |
| 3671 |
|
* properties that the API response will include. |
| 3672 |
|
* |
| 3673 |
|
* Note that this method will override the existing values for mutable |
| 3674 |
|
* properties that are contained in any parts that the request body specifies. |
| 3675 |
|
* For example, a playlist's description is contained in the snippet part, which |
| 3676 |
|
* must be included in the request body. If the request does not specify a value |
| 3677 |
|
* for the snippet.description property, the playlist's existing description |
| 3678 |
|
* will be deleted. |
| 3679 |
|
* @param Google_Playlist $postBody |
| 3680 |
|
* @param array $optParams Optional parameters. |
| 3681 |
|
* |
| 3682 |
|
* @opt_param string onBehalfOfContentOwner Note: This parameter is intended |
| 3683 |
|
* exclusively for YouTube content partners. |
| 3684 |
|
* |
| 3685 |
|
* The onBehalfOfContentOwner parameter indicates that the request's |
| 3686 |
|
* authorization credentials identify a YouTube CMS user who is acting on behalf |
| 3687 |
|
* of the content owner specified in the parameter value. This parameter is |
| 3688 |
|
* intended for YouTube content partners that own and manage many different |
| 3689 |
|
* YouTube channels. It allows content owners to authenticate once and get |
| 3690 |
|
* access to all their video and channel data, without having to provide |
| 3691 |
|
* authentication credentials for each individual channel. The CMS account that |
| 3692 |
|
* the user authenticates with must be linked to the specified YouTube content |
| 3693 |
|
* owner. |
| 3694 |
|
* @return Google_Service_YouTube_Playlist |
| 3695 |
|
*/ |
| 3696 |
|
public function update($part, Google_Service_YouTube_Playlist $postBody, $optParams = array()) |
| 3697 |
|
{ |
| 3698 |
|
$params = array('part' => $part, 'postBody' => $postBody); |
| 3699 |
|
$params = array_merge($params, $optParams); |
| 3700 |
|
return $this->call('update', array($params), "Google_Service_YouTube_Playlist"); |
| 3701 |
|
} |
| 3702 |
|
} |
| 3703 |
|
|
| 3704 |
|
/** |
| 3705 |
|
* The "search" collection of methods. |