/library/Google/vendor/google/apiclient-services/src/Google/Service/YouTube/Resource/ChannelSections.php

  1<?php
  2/*
  3 * Copyright 2014 Google Inc.
  4 *
  5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  6 * use this file except in compliance with the License. You may obtain a copy of
  7 * the License at
  8 *
  9 * http://www.apache.org/licenses/LICENSE-2.0
 10 *
 11 * Unless required by applicable law or agreed to in writing, software
 12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 14 * License for the specific language governing permissions and limitations under
 15 * the License.
 16 */
 17
 18/**
 19 * The "channelSections" collection of methods.
 20 * Typical usage is:
 21 *  <code>
 22 *   $youtubeService = new Google_Service_YouTube(...);
 23 *   $channelSections = $youtubeService->channelSections;
 24 *  </code>
 25 */
 26class Google_Service_YouTube_Resource_ChannelSections extends Google_Service_Resource
 27{
 28  /**
 29   * Deletes a channelSection. (channelSections.delete)
 30   *
 31   * @param string $id The id parameter specifies the YouTube channelSection ID
 32   * for the resource that is being deleted. In a channelSection resource, the id
 33   * property specifies the YouTube channelSection ID.
 34   * @param array $optParams Optional parameters.
 35   *
 36   * @opt_param string onBehalfOfContentOwner Note: This parameter is intended
 37   * exclusively for YouTube content partners.
 38   *
 39   * The onBehalfOfContentOwner parameter indicates that the request's
 40   * authorization credentials identify a YouTube CMS user who is acting on behalf
 41   * of the content owner specified in the parameter value. This parameter is
 42   * intended for YouTube content partners that own and manage many different
 43   * YouTube channels. It allows content owners to authenticate once and get
 44   * access to all their video and channel data, without having to provide
 45   * authentication credentials for each individual channel. The CMS account that
 46   * the user authenticates with must be linked to the specified YouTube content
 47   * owner.
 48   */
 49  public function delete($id, $optParams = array())
 50  {
 51    $params = array('id' => $id);
 52    $params = array_merge($params, $optParams);
 53    return $this->call('delete', array($params));
 54  }
 55  /**
 56   * Adds a channelSection for the authenticated user's channel.
 57   * (channelSections.insert)
 58   *
 59   * @param string $part The part parameter serves two purposes in this operation.
 60   * It identifies the properties that the write operation will set as well as the
 61   * properties that the API response will include.
 62   *
 63   * The part names that you can include in the parameter value are snippet and
 64   * contentDetails.
 65   * @param Google_Service_YouTube_ChannelSection $postBody
 66   * @param array $optParams Optional parameters.
 67   *
 68   * @opt_param string onBehalfOfContentOwner Note: This parameter is intended
 69   * exclusively for YouTube content partners.
 70   *
 71   * The onBehalfOfContentOwner parameter indicates that the request's
 72   * authorization credentials identify a YouTube CMS user who is acting on behalf
 73   * of the content owner specified in the parameter value. This parameter is
 74   * intended for YouTube content partners that own and manage many different
 75   * YouTube channels. It allows content owners to authenticate once and get
 76   * access to all their video and channel data, without having to provide
 77   * authentication credentials for each individual channel. The CMS account that
 78   * the user authenticates with must be linked to the specified YouTube content
 79   * owner.
 80   * @opt_param string onBehalfOfContentOwnerChannel This parameter can only be
 81   * used in a properly authorized request. Note: This parameter is intended
 82   * exclusively for YouTube content partners.
 83   *
 84   * The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID
 85   * of the channel to which a video is being added. This parameter is required
 86   * when a request specifies a value for the onBehalfOfContentOwner parameter,
 87   * and it can only be used in conjunction with that parameter. In addition, the
 88   * request must be authorized using a CMS account that is linked to the content
 89   * owner that the onBehalfOfContentOwner parameter specifies. Finally, the
 90   * channel that the onBehalfOfContentOwnerChannel parameter value specifies must
 91   * be linked to the content owner that the onBehalfOfContentOwner parameter
 92   * specifies.
 93   *
 94   * This parameter is intended for YouTube content partners that own and manage
 95   * many different YouTube channels. It allows content owners to authenticate
 96   * once and perform actions on behalf of the channel specified in the parameter
 97   * value, without having to provide authentication credentials for each separate
 98   * channel.
 99   * @return Google_Service_YouTube_ChannelSection
100   */
101  public function insert($part, Google_Service_YouTube_ChannelSection $postBody, $optParams = array())
102  {
103    $params = array('part' => $part, 'postBody' => $postBody);
104    $params = array_merge($params, $optParams);
105    return $this->call('insert', array($params), "Google_Service_YouTube_ChannelSection");
106  }
107  /**
108   * Returns channelSection resources that match the API request criteria.
109   * (channelSections.listChannelSections)
110   *
111   * @param string $part The part parameter specifies a comma-separated list of
112   * one or more channelSection resource properties that the API response will
113   * include. The part names that you can include in the parameter value are id,
114   * snippet, and contentDetails.
115   *
116   * If the parameter identifies a property that contains child properties, the
117   * child properties will be included in the response. For example, in a
118   * channelSection resource, the snippet property contains other properties, such
119   * as a display title for the channelSection. If you set part=snippet, the API
120   * response will also contain all of those nested properties.
121   * @param array $optParams Optional parameters.
122   *
123   * @opt_param string channelId The channelId parameter specifies a YouTube
124   * channel ID. The API will only return that channel's channelSections.
125   * @opt_param string hl The hl parameter indicates that the snippet.localized
126   * property values in the returned channelSection resources should be in the
127   * specified language if localized values for that language are available. For
128   * example, if the API request specifies hl=de, the snippet.localized properties
129   * in the API response will contain German titles if German titles are
130   * available. Channel owners can provide localized channel section titles using
131   * either the channelSections.insert or channelSections.update method.
132   * @opt_param string id The id parameter specifies a comma-separated list of the
133   * YouTube channelSection ID(s) for the resource(s) that are being retrieved. In
134   * a channelSection resource, the id property specifies the YouTube
135   * channelSection ID.
136   * @opt_param bool mine Set this parameter's value to true to retrieve a feed of
137   * the authenticated user's channelSections.
138   * @opt_param string onBehalfOfContentOwner Note: This parameter is intended
139   * exclusively for YouTube content partners.
140   *
141   * The onBehalfOfContentOwner parameter indicates that the request's
142   * authorization credentials identify a YouTube CMS user who is acting on behalf
143   * of the content owner specified in the parameter value. This parameter is
144   * intended for YouTube content partners that own and manage many different
145   * YouTube channels. It allows content owners to authenticate once and get
146   * access to all their video and channel data, without having to provide
147   * authentication credentials for each individual channel. The CMS account that
148   * the user authenticates with must be linked to the specified YouTube content
149   * owner.
150   * @return Google_Service_YouTube_ChannelSectionListResponse
151   */
152  public function listChannelSections($part, $optParams = array())
153  {
154    $params = array('part' => $part);
155    $params = array_merge($params, $optParams);
156    return $this->call('list', array($params), "Google_Service_YouTube_ChannelSectionListResponse");
157  }
158  /**
159   * Update a channelSection. (channelSections.update)
160   *
161   * @param string $part The part parameter serves two purposes in this operation.
162   * It identifies the properties that the write operation will set as well as the
163   * properties that the API response will include.
164   *
165   * The part names that you can include in the parameter value are snippet and
166   * contentDetails.
167   * @param Google_Service_YouTube_ChannelSection $postBody
168   * @param array $optParams Optional parameters.
169   *
170   * @opt_param string onBehalfOfContentOwner Note: This parameter is intended
171   * exclusively for YouTube content partners.
172   *
173   * The onBehalfOfContentOwner parameter indicates that the request's
174   * authorization credentials identify a YouTube CMS user who is acting on behalf
175   * of the content owner specified in the parameter value. This parameter is
176   * intended for YouTube content partners that own and manage many different
177   * YouTube channels. It allows content owners to authenticate once and get
178   * access to all their video and channel data, without having to provide
179   * authentication credentials for each individual channel. The CMS account that
180   * the user authenticates with must be linked to the specified YouTube content
181   * owner.
182   * @return Google_Service_YouTube_ChannelSection
183   */
184  public function update($part, Google_Service_YouTube_ChannelSection $postBody, $optParams = array())
185  {
186    $params = array('part' => $part, 'postBody' => $postBody);
187    $params = array_merge($params, $optParams);
188    return $this->call('update', array($params), "Google_Service_YouTube_ChannelSection");
189  }
190}