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 | namespace Google\Service\YouTubeAnalytics\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\YouTubeAnalytics\EmptyResponse;
|
---|
21 | use Google\Service\YouTubeAnalytics\GroupItem;
|
---|
22 | use Google\Service\YouTubeAnalytics\ListGroupItemsResponse;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The "groupItems" collection of methods.
|
---|
26 | * Typical usage is:
|
---|
27 | * <code>
|
---|
28 | * $youtubeAnalyticsService = new Google\Service\YouTubeAnalytics(...);
|
---|
29 | * $groupItems = $youtubeAnalyticsService->groupItems;
|
---|
30 | * </code>
|
---|
31 | */
|
---|
32 | class GroupItems extends \Google\Service\Resource
|
---|
33 | {
|
---|
34 | /**
|
---|
35 | * Removes an item from a group. (groupItems.delete)
|
---|
36 | *
|
---|
37 | * @param array $optParams Optional parameters.
|
---|
38 | *
|
---|
39 | * @opt_param string id The `id` parameter specifies the YouTube group item ID
|
---|
40 | * of the group item that is being deleted.
|
---|
41 | * @opt_param string onBehalfOfContentOwner This parameter can only be used in a
|
---|
42 | * properly authorized request. **Note:** This parameter is intended exclusively
|
---|
43 | * for YouTube content partners that own and manage many different YouTube
|
---|
44 | * channels. The `onBehalfOfContentOwner` parameter indicates that the request's
|
---|
45 | * authorization credentials identify a YouTube user who is acting on behalf of
|
---|
46 | * the content owner specified in the parameter value. It allows content owners
|
---|
47 | * to authenticate once and get access to all their video and channel data,
|
---|
48 | * without having to provide authentication credentials for each individual
|
---|
49 | * channel. The account that the user authenticates with must be linked to the
|
---|
50 | * specified YouTube content owner.
|
---|
51 | * @return EmptyResponse
|
---|
52 | * @throws \Google\Service\Exception
|
---|
53 | */
|
---|
54 | public function delete($optParams = [])
|
---|
55 | {
|
---|
56 | $params = [];
|
---|
57 | $params = array_merge($params, $optParams);
|
---|
58 | return $this->call('delete', [$params], EmptyResponse::class);
|
---|
59 | }
|
---|
60 | /**
|
---|
61 | * Creates a group item. (groupItems.insert)
|
---|
62 | *
|
---|
63 | * @param GroupItem $postBody
|
---|
64 | * @param array $optParams Optional parameters.
|
---|
65 | *
|
---|
66 | * @opt_param string onBehalfOfContentOwner This parameter can only be used in a
|
---|
67 | * properly authorized request. **Note:** This parameter is intended exclusively
|
---|
68 | * for YouTube content partners that own and manage many different YouTube
|
---|
69 | * channels. The `onBehalfOfContentOwner` parameter indicates that the request's
|
---|
70 | * authorization credentials identify a YouTube user who is acting on behalf of
|
---|
71 | * the content owner specified in the parameter value. It allows content owners
|
---|
72 | * to authenticate once and get access to all their video and channel data,
|
---|
73 | * without having to provide authentication credentials for each individual
|
---|
74 | * channel. The account that the user authenticates with must be linked to the
|
---|
75 | * specified YouTube content owner.
|
---|
76 | * @return GroupItem
|
---|
77 | * @throws \Google\Service\Exception
|
---|
78 | */
|
---|
79 | public function insert(GroupItem $postBody, $optParams = [])
|
---|
80 | {
|
---|
81 | $params = ['postBody' => $postBody];
|
---|
82 | $params = array_merge($params, $optParams);
|
---|
83 | return $this->call('insert', [$params], GroupItem::class);
|
---|
84 | }
|
---|
85 | /**
|
---|
86 | * Returns a collection of group items that match the API request parameters.
|
---|
87 | * (groupItems.listGroupItems)
|
---|
88 | *
|
---|
89 | * @param array $optParams Optional parameters.
|
---|
90 | *
|
---|
91 | * @opt_param string groupId The `groupId` parameter specifies the unique ID of
|
---|
92 | * the group for which you want to retrieve group items.
|
---|
93 | * @opt_param string onBehalfOfContentOwner This parameter can only be used in a
|
---|
94 | * properly authorized request. **Note:** This parameter is intended exclusively
|
---|
95 | * for YouTube content partners that own and manage many different YouTube
|
---|
96 | * channels. The `onBehalfOfContentOwner` parameter indicates that the request's
|
---|
97 | * authorization credentials identify a YouTube user who is acting on behalf of
|
---|
98 | * the content owner specified in the parameter value. It allows content owners
|
---|
99 | * to authenticate once and get access to all their video and channel data,
|
---|
100 | * without having to provide authentication credentials for each individual
|
---|
101 | * channel. The account that the user authenticates with must be linked to the
|
---|
102 | * specified YouTube content owner.
|
---|
103 | * @return ListGroupItemsResponse
|
---|
104 | * @throws \Google\Service\Exception
|
---|
105 | */
|
---|
106 | public function listGroupItems($optParams = [])
|
---|
107 | {
|
---|
108 | $params = [];
|
---|
109 | $params = array_merge($params, $optParams);
|
---|
110 | return $this->call('list', [$params], ListGroupItemsResponse::class);
|
---|
111 | }
|
---|
112 | }
|
---|
113 |
|
---|
114 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
115 | class_alias(GroupItems::class, 'Google_Service_YouTubeAnalytics_Resource_GroupItems');
|
---|