[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\DoubleClickBidManager\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\DoubleClickBidManager\ListReportsResponse;
|
---|
| 21 | use Google\Service\DoubleClickBidManager\Report;
|
---|
| 22 |
|
---|
| 23 | /**
|
---|
| 24 | * The "reports" collection of methods.
|
---|
| 25 | * Typical usage is:
|
---|
| 26 | * <code>
|
---|
| 27 | * $doubleclickbidmanagerService = new Google\Service\DoubleClickBidManager(...);
|
---|
| 28 | * $reports = $doubleclickbidmanagerService->queries_reports;
|
---|
| 29 | * </code>
|
---|
| 30 | */
|
---|
| 31 | class QueriesReports extends \Google\Service\Resource
|
---|
| 32 | {
|
---|
| 33 | /**
|
---|
| 34 | * Retrieves a report. (reports.get)
|
---|
| 35 | *
|
---|
| 36 | * @param string $queryId Required. The ID of the query that generated the
|
---|
| 37 | * report.
|
---|
| 38 | * @param string $reportId Required. The ID of the query to retrieve.
|
---|
| 39 | * @param array $optParams Optional parameters.
|
---|
| 40 | * @return Report
|
---|
| 41 | * @throws \Google\Service\Exception
|
---|
| 42 | */
|
---|
| 43 | public function get($queryId, $reportId, $optParams = [])
|
---|
| 44 | {
|
---|
| 45 | $params = ['queryId' => $queryId, 'reportId' => $reportId];
|
---|
| 46 | $params = array_merge($params, $optParams);
|
---|
| 47 | return $this->call('get', [$params], Report::class);
|
---|
| 48 | }
|
---|
| 49 | /**
|
---|
| 50 | * Lists reports generated by the provided query. (reports.listQueriesReports)
|
---|
| 51 | *
|
---|
| 52 | * @param string $queryId Required. The ID of the query that generated the
|
---|
| 53 | * reports.
|
---|
| 54 | * @param array $optParams Optional parameters.
|
---|
| 55 | *
|
---|
| 56 | * @opt_param string orderBy Field to sort the list by. Accepts the following
|
---|
| 57 | * values: * `key.reportId` (default) The default sorting order is ascending. To
|
---|
| 58 | * specify descending order for a field, add the suffix `desc` to the field
|
---|
| 59 | * name. For example, `key.reportId desc`.
|
---|
| 60 | * @opt_param int pageSize Maximum number of results per page. Must be between
|
---|
| 61 | * `1` and `100`. Defaults to `100` if unspecified.
|
---|
| 62 | * @opt_param string pageToken A token identifying which page of results the
|
---|
| 63 | * server should return. Typically, this is the value of nextPageToken returned
|
---|
| 64 | * from the previous call to the `queries.reports.list` method. If unspecified,
|
---|
| 65 | * the first page of results is returned.
|
---|
| 66 | * @return ListReportsResponse
|
---|
| 67 | * @throws \Google\Service\Exception
|
---|
| 68 | */
|
---|
| 69 | public function listQueriesReports($queryId, $optParams = [])
|
---|
| 70 | {
|
---|
| 71 | $params = ['queryId' => $queryId];
|
---|
| 72 | $params = array_merge($params, $optParams);
|
---|
| 73 | return $this->call('list', [$params], ListReportsResponse::class);
|
---|
| 74 | }
|
---|
| 75 | }
|
---|
| 76 |
|
---|
| 77 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 78 | class_alias(QueriesReports::class, 'Google_Service_DoubleClickBidManager_Resource_QueriesReports');
|
---|