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 "userUsageReport" collection of methods.
20 * Typical usage is:
21 *  <code>
22 *   $adminService = new Google_Service_Reports(...);
23 *   $userUsageReport = $adminService->userUsageReport;
24 *  </code>
25 */
26class Google_Service_Reports_Resource_UserUsageReport extends Google_Service_Resource
27{
28  /**
29   * Retrieves a report which is a collection of properties / statistics for a set
30   * of users. (userUsageReport.get)
31   *
32   * @param string $userKey Represents the profile id or the user email for which
33   * the data should be filtered.
34   * @param string $date Represents the date in yyyy-mm-dd format for which the
35   * data is to be fetched.
36   * @param array $optParams Optional parameters.
37   *
38   * @opt_param string customerId Represents the customer for which the data is to
39   * be fetched.
40   * @opt_param string filters Represents the set of filters including parameter
41   * operator value.
42   * @opt_param string maxResults Maximum number of results to return. Maximum
43   * allowed is 1000
44   * @opt_param string orgUnitID the organizational unit's ID to filter usage
45   * parameters from users belonging to a specific OU or one of its sub-OU(s).
46   * @opt_param string pageToken Token to specify next page.
47   * @opt_param string parameters Represents the application name, parameter name
48   * pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
49   * @return Google_Service_Reports_UsageReports
50   */
51  public function get($userKey, $date, $optParams = array())
52  {
53    $params = array('userKey' => $userKey, 'date' => $date);
54    $params = array_merge($params, $optParams);
55    return $this->call('get', array($params), "Google_Service_Reports_UsageReports");
56  }
57}
58