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\AdExchangeBuyer\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\AdExchangeBuyer\PerformanceReportList;
|
---|
21 |
|
---|
22 | /**
|
---|
23 | * The "performanceReport" collection of methods.
|
---|
24 | * Typical usage is:
|
---|
25 | * <code>
|
---|
26 | * $adexchangebuyerService = new Google\Service\AdExchangeBuyer(...);
|
---|
27 | * $performanceReport = $adexchangebuyerService->performanceReport;
|
---|
28 | * </code>
|
---|
29 | */
|
---|
30 | class PerformanceReport extends \Google\Service\Resource
|
---|
31 | {
|
---|
32 | /**
|
---|
33 | * Retrieves the authenticated user's list of performance metrics.
|
---|
34 | * (performanceReport.listPerformanceReport)
|
---|
35 | *
|
---|
36 | * @param string $accountId The account id to get the reports.
|
---|
37 | * @param string $endDateTime The end time of the report in ISO 8601 timestamp
|
---|
38 | * format using UTC.
|
---|
39 | * @param string $startDateTime The start time of the report in ISO 8601
|
---|
40 | * timestamp format using UTC.
|
---|
41 | * @param array $optParams Optional parameters.
|
---|
42 | *
|
---|
43 | * @opt_param string maxResults Maximum number of entries returned on one result
|
---|
44 | * page. If not set, the default is 100. Optional.
|
---|
45 | * @opt_param string pageToken A continuation token, used to page through
|
---|
46 | * performance reports. To retrieve the next page, set this parameter to the
|
---|
47 | * value of "nextPageToken" from the previous response. Optional.
|
---|
48 | * @return PerformanceReportList
|
---|
49 | */
|
---|
50 | public function listPerformanceReport($accountId, $endDateTime, $startDateTime, $optParams = [])
|
---|
51 | {
|
---|
52 | $params = ['accountId' => $accountId, 'endDateTime' => $endDateTime, 'startDateTime' => $startDateTime];
|
---|
53 | $params = array_merge($params, $optParams);
|
---|
54 | return $this->call('list', [$params], PerformanceReportList::class);
|
---|
55 | }
|
---|
56 | }
|
---|
57 |
|
---|
58 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
59 | class_alias(PerformanceReport::class, 'Google_Service_AdExchangeBuyer_Resource_PerformanceReport');
|
---|