[e3d4e0a] | 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\Analytics\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\Analytics\UnsampledReport;
|
---|
| 21 | use Google\Service\Analytics\UnsampledReports;
|
---|
| 22 |
|
---|
| 23 | /**
|
---|
| 24 | * The "unsampledReports" collection of methods.
|
---|
| 25 | * Typical usage is:
|
---|
| 26 | * <code>
|
---|
| 27 | * $analyticsService = new Google\Service\Analytics(...);
|
---|
| 28 | * $unsampledReports = $analyticsService->management_unsampledReports;
|
---|
| 29 | * </code>
|
---|
| 30 | */
|
---|
| 31 | class ManagementUnsampledReports extends \Google\Service\Resource
|
---|
| 32 | {
|
---|
| 33 | /**
|
---|
| 34 | * Deletes an unsampled report. (unsampledReports.delete)
|
---|
| 35 | *
|
---|
| 36 | * @param string $accountId Account ID to delete the unsampled report for.
|
---|
| 37 | * @param string $webPropertyId Web property ID to delete the unsampled reports
|
---|
| 38 | * for.
|
---|
| 39 | * @param string $profileId View (Profile) ID to delete the unsampled report
|
---|
| 40 | * for.
|
---|
| 41 | * @param string $unsampledReportId ID of the unsampled report to be deleted.
|
---|
| 42 | * @param array $optParams Optional parameters.
|
---|
| 43 | * @throws \Google\Service\Exception
|
---|
| 44 | */
|
---|
| 45 | public function delete($accountId, $webPropertyId, $profileId, $unsampledReportId, $optParams = [])
|
---|
| 46 | {
|
---|
| 47 | $params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'unsampledReportId' => $unsampledReportId];
|
---|
| 48 | $params = array_merge($params, $optParams);
|
---|
| 49 | return $this->call('delete', [$params]);
|
---|
| 50 | }
|
---|
| 51 | /**
|
---|
| 52 | * Returns a single unsampled report. (unsampledReports.get)
|
---|
| 53 | *
|
---|
| 54 | * @param string $accountId Account ID to retrieve unsampled report for.
|
---|
| 55 | * @param string $webPropertyId Web property ID to retrieve unsampled reports
|
---|
| 56 | * for.
|
---|
| 57 | * @param string $profileId View (Profile) ID to retrieve unsampled report for.
|
---|
| 58 | * @param string $unsampledReportId ID of the unsampled report to retrieve.
|
---|
| 59 | * @param array $optParams Optional parameters.
|
---|
| 60 | * @return UnsampledReport
|
---|
| 61 | * @throws \Google\Service\Exception
|
---|
| 62 | */
|
---|
| 63 | public function get($accountId, $webPropertyId, $profileId, $unsampledReportId, $optParams = [])
|
---|
| 64 | {
|
---|
| 65 | $params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'unsampledReportId' => $unsampledReportId];
|
---|
| 66 | $params = array_merge($params, $optParams);
|
---|
| 67 | return $this->call('get', [$params], UnsampledReport::class);
|
---|
| 68 | }
|
---|
| 69 | /**
|
---|
| 70 | * Create a new unsampled report. (unsampledReports.insert)
|
---|
| 71 | *
|
---|
| 72 | * @param string $accountId Account ID to create the unsampled report for.
|
---|
| 73 | * @param string $webPropertyId Web property ID to create the unsampled report
|
---|
| 74 | * for.
|
---|
| 75 | * @param string $profileId View (Profile) ID to create the unsampled report
|
---|
| 76 | * for.
|
---|
| 77 | * @param UnsampledReport $postBody
|
---|
| 78 | * @param array $optParams Optional parameters.
|
---|
| 79 | * @return UnsampledReport
|
---|
| 80 | * @throws \Google\Service\Exception
|
---|
| 81 | */
|
---|
| 82 | public function insert($accountId, $webPropertyId, $profileId, UnsampledReport $postBody, $optParams = [])
|
---|
| 83 | {
|
---|
| 84 | $params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'postBody' => $postBody];
|
---|
| 85 | $params = array_merge($params, $optParams);
|
---|
| 86 | return $this->call('insert', [$params], UnsampledReport::class);
|
---|
| 87 | }
|
---|
| 88 | /**
|
---|
| 89 | * Lists unsampled reports to which the user has access.
|
---|
| 90 | * (unsampledReports.listManagementUnsampledReports)
|
---|
| 91 | *
|
---|
| 92 | * @param string $accountId Account ID to retrieve unsampled reports for. Must
|
---|
| 93 | * be a specific account ID, ~all is not supported.
|
---|
| 94 | * @param string $webPropertyId Web property ID to retrieve unsampled reports
|
---|
| 95 | * for. Must be a specific web property ID, ~all is not supported.
|
---|
| 96 | * @param string $profileId View (Profile) ID to retrieve unsampled reports for.
|
---|
| 97 | * Must be a specific view (profile) ID, ~all is not supported.
|
---|
| 98 | * @param array $optParams Optional parameters.
|
---|
| 99 | *
|
---|
| 100 | * @opt_param int max-results The maximum number of unsampled reports to include
|
---|
| 101 | * in this response.
|
---|
| 102 | * @opt_param int start-index An index of the first unsampled report to
|
---|
| 103 | * retrieve. Use this parameter as a pagination mechanism along with the max-
|
---|
| 104 | * results parameter.
|
---|
| 105 | * @return UnsampledReports
|
---|
| 106 | * @throws \Google\Service\Exception
|
---|
| 107 | */
|
---|
| 108 | public function listManagementUnsampledReports($accountId, $webPropertyId, $profileId, $optParams = [])
|
---|
| 109 | {
|
---|
| 110 | $params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId];
|
---|
| 111 | $params = array_merge($params, $optParams);
|
---|
| 112 | return $this->call('list', [$params], UnsampledReports::class);
|
---|
| 113 | }
|
---|
| 114 | }
|
---|
| 115 |
|
---|
| 116 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 117 | class_alias(ManagementUnsampledReports::class, 'Google_Service_Analytics_Resource_ManagementUnsampledReports');
|
---|