source: vendor/google/apiclient-services/src/Reports.php@ e3d4e0a

Last change on this file since e3d4e0a was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 7 days ago

Upload project files
  • Property mode set to 100644
File size: 10.7 KB
Line 
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
18namespace Google\Service;
19
20use Google\Client;
21
22/**
23 * Service definition for Reports (reports_v1).
24 *
25 * <p>
26 * Admin SDK lets administrators of enterprise domains to view and manage
27 * resources like user, groups etc. It also provides audit and usage reports of
28 * domain.</p>
29 *
30 * <p>
31 * For more information about this service, see the API
32 * <a href="https://developers.google.com/admin-sdk/" target="_blank">Documentation</a>
33 * </p>
34 *
35 * @author Google, Inc.
36 */
37class Reports extends \Google\Service
38{
39 /** View audit reports for your G Suite domain. */
40 const ADMIN_REPORTS_AUDIT_READONLY =
41 "https://www.googleapis.com/auth/admin.reports.audit.readonly";
42 /** View usage reports for your G Suite domain. */
43 const ADMIN_REPORTS_USAGE_READONLY =
44 "https://www.googleapis.com/auth/admin.reports.usage.readonly";
45
46 public $activities;
47 public $channels;
48 public $customerUsageReports;
49 public $entityUsageReports;
50 public $userUsageReport;
51 public $rootUrlTemplate;
52
53 /**
54 * Constructs the internal representation of the Reports service.
55 *
56 * @param Client|array $clientOrConfig The client used to deliver requests, or a
57 * config array to pass to a new Client instance.
58 * @param string $rootUrl The root URL used for requests to the service.
59 */
60 public function __construct($clientOrConfig = [], $rootUrl = null)
61 {
62 parent::__construct($clientOrConfig);
63 $this->rootUrl = $rootUrl ?: 'https://admin.googleapis.com/';
64 $this->rootUrlTemplate = $rootUrl ?: 'https://admin.UNIVERSE_DOMAIN/';
65 $this->servicePath = '';
66 $this->batchPath = 'batch';
67 $this->version = 'reports_v1';
68 $this->serviceName = 'admin';
69
70 $this->activities = new Reports\Resource\Activities(
71 $this,
72 $this->serviceName,
73 'activities',
74 [
75 'methods' => [
76 'list' => [
77 'path' => 'admin/reports/v1/activity/users/{userKey}/applications/{applicationName}',
78 'httpMethod' => 'GET',
79 'parameters' => [
80 'userKey' => [
81 'location' => 'path',
82 'type' => 'string',
83 'required' => true,
84 ],
85 'applicationName' => [
86 'location' => 'path',
87 'type' => 'string',
88 'required' => true,
89 ],
90 'actorIpAddress' => [
91 'location' => 'query',
92 'type' => 'string',
93 ],
94 'customerId' => [
95 'location' => 'query',
96 'type' => 'string',
97 ],
98 'endTime' => [
99 'location' => 'query',
100 'type' => 'string',
101 ],
102 'eventName' => [
103 'location' => 'query',
104 'type' => 'string',
105 ],
106 'filters' => [
107 'location' => 'query',
108 'type' => 'string',
109 ],
110 'groupIdFilter' => [
111 'location' => 'query',
112 'type' => 'string',
113 ],
114 'maxResults' => [
115 'location' => 'query',
116 'type' => 'integer',
117 ],
118 'orgUnitID' => [
119 'location' => 'query',
120 'type' => 'string',
121 ],
122 'pageToken' => [
123 'location' => 'query',
124 'type' => 'string',
125 ],
126 'startTime' => [
127 'location' => 'query',
128 'type' => 'string',
129 ],
130 ],
131 ],'watch' => [
132 'path' => 'admin/reports/v1/activity/users/{userKey}/applications/{applicationName}/watch',
133 'httpMethod' => 'POST',
134 'parameters' => [
135 'userKey' => [
136 'location' => 'path',
137 'type' => 'string',
138 'required' => true,
139 ],
140 'applicationName' => [
141 'location' => 'path',
142 'type' => 'string',
143 'required' => true,
144 ],
145 'actorIpAddress' => [
146 'location' => 'query',
147 'type' => 'string',
148 ],
149 'customerId' => [
150 'location' => 'query',
151 'type' => 'string',
152 ],
153 'endTime' => [
154 'location' => 'query',
155 'type' => 'string',
156 ],
157 'eventName' => [
158 'location' => 'query',
159 'type' => 'string',
160 ],
161 'filters' => [
162 'location' => 'query',
163 'type' => 'string',
164 ],
165 'groupIdFilter' => [
166 'location' => 'query',
167 'type' => 'string',
168 ],
169 'maxResults' => [
170 'location' => 'query',
171 'type' => 'integer',
172 ],
173 'orgUnitID' => [
174 'location' => 'query',
175 'type' => 'string',
176 ],
177 'pageToken' => [
178 'location' => 'query',
179 'type' => 'string',
180 ],
181 'startTime' => [
182 'location' => 'query',
183 'type' => 'string',
184 ],
185 ],
186 ],
187 ]
188 ]
189 );
190 $this->channels = new Reports\Resource\Channels(
191 $this,
192 $this->serviceName,
193 'channels',
194 [
195 'methods' => [
196 'stop' => [
197 'path' => 'admin/reports_v1/channels/stop',
198 'httpMethod' => 'POST',
199 'parameters' => [],
200 ],
201 ]
202 ]
203 );
204 $this->customerUsageReports = new Reports\Resource\CustomerUsageReports(
205 $this,
206 $this->serviceName,
207 'customerUsageReports',
208 [
209 'methods' => [
210 'get' => [
211 'path' => 'admin/reports/v1/usage/dates/{date}',
212 'httpMethod' => 'GET',
213 'parameters' => [
214 'date' => [
215 'location' => 'path',
216 'type' => 'string',
217 'required' => true,
218 ],
219 'customerId' => [
220 'location' => 'query',
221 'type' => 'string',
222 ],
223 'pageToken' => [
224 'location' => 'query',
225 'type' => 'string',
226 ],
227 'parameters' => [
228 'location' => 'query',
229 'type' => 'string',
230 ],
231 ],
232 ],
233 ]
234 ]
235 );
236 $this->entityUsageReports = new Reports\Resource\EntityUsageReports(
237 $this,
238 $this->serviceName,
239 'entityUsageReports',
240 [
241 'methods' => [
242 'get' => [
243 'path' => 'admin/reports/v1/usage/{entityType}/{entityKey}/dates/{date}',
244 'httpMethod' => 'GET',
245 'parameters' => [
246 'entityType' => [
247 'location' => 'path',
248 'type' => 'string',
249 'required' => true,
250 ],
251 'entityKey' => [
252 'location' => 'path',
253 'type' => 'string',
254 'required' => true,
255 ],
256 'date' => [
257 'location' => 'path',
258 'type' => 'string',
259 'required' => true,
260 ],
261 'customerId' => [
262 'location' => 'query',
263 'type' => 'string',
264 ],
265 'filters' => [
266 'location' => 'query',
267 'type' => 'string',
268 ],
269 'maxResults' => [
270 'location' => 'query',
271 'type' => 'integer',
272 ],
273 'pageToken' => [
274 'location' => 'query',
275 'type' => 'string',
276 ],
277 'parameters' => [
278 'location' => 'query',
279 'type' => 'string',
280 ],
281 ],
282 ],
283 ]
284 ]
285 );
286 $this->userUsageReport = new Reports\Resource\UserUsageReport(
287 $this,
288 $this->serviceName,
289 'userUsageReport',
290 [
291 'methods' => [
292 'get' => [
293 'path' => 'admin/reports/v1/usage/users/{userKey}/dates/{date}',
294 'httpMethod' => 'GET',
295 'parameters' => [
296 'userKey' => [
297 'location' => 'path',
298 'type' => 'string',
299 'required' => true,
300 ],
301 'date' => [
302 'location' => 'path',
303 'type' => 'string',
304 'required' => true,
305 ],
306 'customerId' => [
307 'location' => 'query',
308 'type' => 'string',
309 ],
310 'filters' => [
311 'location' => 'query',
312 'type' => 'string',
313 ],
314 'groupIdFilter' => [
315 'location' => 'query',
316 'type' => 'string',
317 ],
318 'maxResults' => [
319 'location' => 'query',
320 'type' => 'integer',
321 ],
322 'orgUnitID' => [
323 'location' => 'query',
324 'type' => 'string',
325 ],
326 'pageToken' => [
327 'location' => 'query',
328 'type' => 'string',
329 ],
330 'parameters' => [
331 'location' => 'query',
332 'type' => 'string',
333 ],
334 ],
335 ],
336 ]
337 ]
338 );
339 }
340}
341
342// Adding a class alias for backwards compatibility with the previous class name.
343class_alias(Reports::class, 'Google_Service_Reports');
Note: See TracBrowser for help on using the repository browser.