/library/Google/vendor/google/apiclient-services/src/Google/Service/YouTube/Resource/Sponsors.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 "sponsors" collection of methods.
20 * Typical usage is:
21 *  <code>
22 *   $youtubeService = new Google_Service_YouTube(...);
23 *   $sponsors = $youtubeService->sponsors;
24 *  </code>
25 */
26class Google_Service_YouTube_Resource_Sponsors extends Google_Service_Resource
27{
28  /**
29   * Lists sponsors for a channel. (sponsors.listSponsors)
30   *
31   * @param string $part The part parameter specifies the sponsor resource parts
32   * that the API response will include. Supported values are id and snippet.
33   * @param array $optParams Optional parameters.
34   *
35   * @opt_param string filter The filter parameter specifies which channel
36   * sponsors to return.
37   * @opt_param string maxResults The maxResults parameter specifies the maximum
38   * number of items that should be returned in the result set.
39   * @opt_param string pageToken The pageToken parameter identifies a specific
40   * page in the result set that should be returned. In an API response, the
41   * nextPageToken and prevPageToken properties identify other pages that could be
42   * retrieved.
43   * @return Google_Service_YouTube_SponsorListResponse
44   */
45  public function listSponsors($part, $optParams = array())
46  {
47    $params = array('part' => $part);
48    $params = array_merge($params, $optParams);
49    return $this->call('list', array($params), "Google_Service_YouTube_SponsorListResponse");
50  }
51}