Google_Service_YouTube_ChannelSections_Resource

The "channelSections" collection of methods.

Defined (1)

The class is defined in the following location(s).

/includes/api-libs/Google/Service/YouTube.php  
  1. class Google_Service_YouTube_ChannelSections_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Deletes a channelSection. (channelSections.delete) 
  5. * @param string $id The id parameter specifies the YouTube channelSection ID 
  6. * for the resource that is being deleted. In a channelSection resource, the id 
  7. * property specifies the YouTube channelSection ID. 
  8. * @param array $optParams Optional parameters. 
  9. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  10. * exclusively for YouTube content partners. 
  11. * The onBehalfOfContentOwner parameter indicates that the request's 
  12. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  13. * of the content owner specified in the parameter value. This parameter is 
  14. * intended for YouTube content partners that own and manage many different 
  15. * YouTube channels. It allows content owners to authenticate once and get 
  16. * access to all their video and channel data, without having to provide 
  17. * authentication credentials for each individual channel. The CMS account that 
  18. * the user authenticates with must be linked to the specified YouTube content 
  19. * owner. 
  20. */ 
  21. public function delete($id, $optParams = array()) 
  22. $params = array('id' => $id); 
  23. $params = array_merge($params, $optParams); 
  24. return $this->call('delete', array($params)); 
  25.  
  26. /** 
  27. * Adds a channelSection for the authenticated user's channel. 
  28. * (channelSections.insert) 
  29. * @param string $part The part parameter serves two purposes in this operation. 
  30. * It identifies the properties that the write operation will set as well as the 
  31. * properties that the API response will include. 
  32. * The part names that you can include in the parameter value are snippet and 
  33. * contentDetails. 
  34. * @param Google_ChannelSection $postBody 
  35. * @param array $optParams Optional parameters. 
  36. * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be 
  37. * used in a properly authorized request. Note: This parameter is intended 
  38. * exclusively for YouTube content partners. 
  39. * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID 
  40. * of the channel to which a video is being added. This parameter is required 
  41. * when a request specifies a value for the onBehalfOfContentOwner parameter,  
  42. * and it can only be used in conjunction with that parameter. In addition, the 
  43. * request must be authorized using a CMS account that is linked to the content 
  44. * owner that the onBehalfOfContentOwner parameter specifies. Finally, the 
  45. * channel that the onBehalfOfContentOwnerChannel parameter value specifies must 
  46. * be linked to the content owner that the onBehalfOfContentOwner parameter 
  47. * specifies. 
  48. * This parameter is intended for YouTube content partners that own and manage 
  49. * many different YouTube channels. It allows content owners to authenticate 
  50. * once and perform actions on behalf of the channel specified in the parameter 
  51. * value, without having to provide authentication credentials for each separate 
  52. * channel. 
  53. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  54. * exclusively for YouTube content partners. 
  55. * The onBehalfOfContentOwner parameter indicates that the request's 
  56. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  57. * of the content owner specified in the parameter value. This parameter is 
  58. * intended for YouTube content partners that own and manage many different 
  59. * YouTube channels. It allows content owners to authenticate once and get 
  60. * access to all their video and channel data, without having to provide 
  61. * authentication credentials for each individual channel. The CMS account that 
  62. * the user authenticates with must be linked to the specified YouTube content 
  63. * owner. 
  64. * @return Google_Service_YouTube_ChannelSection 
  65. */ 
  66. public function insert($part, Google_Service_YouTube_ChannelSection $postBody, $optParams = array()) 
  67. $params = array('part' => $part, 'postBody' => $postBody); 
  68. $params = array_merge($params, $optParams); 
  69. return $this->call('insert', array($params), "Google_Service_YouTube_ChannelSection"); 
  70.  
  71. /** 
  72. * Returns channelSection resources that match the API request criteria. 
  73. * (channelSections.listChannelSections) 
  74. * @param string $part The part parameter specifies a comma-separated list of 
  75. * one or more channelSection resource properties that the API response will 
  76. * include. The part names that you can include in the parameter value are id,  
  77. * snippet, and contentDetails. 
  78. * If the parameter identifies a property that contains child properties, the 
  79. * child properties will be included in the response. For example, in a 
  80. * channelSection resource, the snippet property contains other properties, such 
  81. * as a display title for the channelSection. If you set part=snippet, the API 
  82. * response will also contain all of those nested properties. 
  83. * @param array $optParams Optional parameters. 
  84. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  85. * exclusively for YouTube content partners. 
  86. * The onBehalfOfContentOwner parameter indicates that the request's 
  87. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  88. * of the content owner specified in the parameter value. This parameter is 
  89. * intended for YouTube content partners that own and manage many different 
  90. * YouTube channels. It allows content owners to authenticate once and get 
  91. * access to all their video and channel data, without having to provide 
  92. * authentication credentials for each individual channel. The CMS account that 
  93. * the user authenticates with must be linked to the specified YouTube content 
  94. * owner. 
  95. * @opt_param string channelId The channelId parameter specifies a YouTube 
  96. * channel ID. The API will only return that channel's channelSections. 
  97. * @opt_param string id The id parameter specifies a comma-separated list of the 
  98. * YouTube channelSection ID(s) for the resource(s) that are being retrieved. In 
  99. * a channelSection resource, the id property specifies the YouTube 
  100. * channelSection ID. 
  101. * @opt_param bool mine Set this parameter's value to true to retrieve a feed of 
  102. * the authenticated user's channelSections. 
  103. * @return Google_Service_YouTube_ChannelSectionListResponse 
  104. */ 
  105. public function listChannelSections($part, $optParams = array()) 
  106. $params = array('part' => $part); 
  107. $params = array_merge($params, $optParams); 
  108. return $this->call('list', array($params), "Google_Service_YouTube_ChannelSectionListResponse"); 
  109.  
  110. /** 
  111. * Update a channelSection. (channelSections.update) 
  112. * @param string $part The part parameter serves two purposes in this operation. 
  113. * It identifies the properties that the write operation will set as well as the 
  114. * properties that the API response will include. 
  115. * The part names that you can include in the parameter value are snippet and 
  116. * contentDetails. 
  117. * @param Google_ChannelSection $postBody 
  118. * @param array $optParams Optional parameters. 
  119. * @opt_param string onBehalfOfContentOwner Note: This parameter is intended 
  120. * exclusively for YouTube content partners. 
  121. * The onBehalfOfContentOwner parameter indicates that the request's 
  122. * authorization credentials identify a YouTube CMS user who is acting on behalf 
  123. * of the content owner specified in the parameter value. This parameter is 
  124. * intended for YouTube content partners that own and manage many different 
  125. * YouTube channels. It allows content owners to authenticate once and get 
  126. * access to all their video and channel data, without having to provide 
  127. * authentication credentials for each individual channel. The CMS account that 
  128. * the user authenticates with must be linked to the specified YouTube content 
  129. * owner. 
  130. * @return Google_Service_YouTube_ChannelSection 
  131. */ 
  132. public function update($part, Google_Service_YouTube_ChannelSection $postBody, $optParams = array()) 
  133. $params = array('part' => $part, 'postBody' => $postBody); 
  134. $params = array_merge($params, $optParams); 
  135. return $this->call('update', array($params), "Google_Service_YouTube_ChannelSection");