Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_YouTube_ChannelBanners_Resource Class Reference

The "channelBanners" collection of methods. More...

Inheritance diagram for Google_Service_YouTube_ChannelBanners_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 insert (Google_Service_YouTube_ChannelBannerResource $postBody, $optParams=array())
 Uploads a channel banner image to YouTube.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "channelBanners" collection of methods.

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

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

◆ insert()

Google_Service_YouTube_ChannelBanners_Resource::insert ( Google_Service_YouTube_ChannelBannerResource $postBody,
$optParams = array() )

Uploads a channel banner image to YouTube.

This method represents the first two steps in a three-step process to update the banner image for a channel:

  • Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels. - Extract the url property's value from the response that the API returns for step 1. - Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2. (channelBanners.insert)
Parameters
Google_ChannelBannerResource$postBody
array$optParamsOptional 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 values
Google_Service_YouTube_ChannelBannerResource

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