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\Doubleclicksearch\Resource;
19
20use Google\Service\Doubleclicksearch\Report;
21use Google\Service\Doubleclicksearch\ReportRequest;
22
23/**
24 * The "reports" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $doubleclicksearchService = new Google\Service\Doubleclicksearch(...);
28 *   $reports = $doubleclicksearchService->reports;
29 *  </code>
30 */
31class Reports extends \Google\Service\Resource
32{
33  /**
34   * Generates and returns a report immediately. (reports.generate)
35   *
36   * @param ReportRequest $postBody
37   * @param array $optParams Optional parameters.
38   * @return Report
39   */
40  public function generate(ReportRequest $postBody, $optParams = [])
41  {
42    $params = ['postBody' => $postBody];
43    $params = array_merge($params, $optParams);
44    return $this->call('generate', [$params], Report::class);
45  }
46  /**
47   * Polls for the status of a report request. (reports.get)
48   *
49   * @param string $reportId ID of the report request being polled.
50   * @param array $optParams Optional parameters.
51   * @return Report
52   */
53  public function get($reportId, $optParams = [])
54  {
55    $params = ['reportId' => $reportId];
56    $params = array_merge($params, $optParams);
57    return $this->call('get', [$params], Report::class);
58  }
59  /**
60   * Downloads a report file encoded in UTF-8. (reports.getFile)
61   *
62   * @param string $reportId ID of the report.
63   * @param int $reportFragment The index of the report fragment to download.
64   * @param array $optParams Optional parameters.
65   */
66  public function getFile($reportId, $reportFragment, $optParams = [])
67  {
68    $params = ['reportId' => $reportId, 'reportFragment' => $reportFragment];
69    $params = array_merge($params, $optParams);
70    return $this->call('getFile', [$params]);
71  }
72  /**
73   * Inserts a report request into the reporting system. (reports.request)
74   *
75   * @param ReportRequest $postBody
76   * @param array $optParams Optional parameters.
77   * @return Report
78   */
79  public function request(ReportRequest $postBody, $optParams = [])
80  {
81    $params = ['postBody' => $postBody];
82    $params = array_merge($params, $optParams);
83    return $this->call('request', [$params], Report::class);
84  }
85}
86
87// Adding a class alias for backwards compatibility with the previous class name.
88class_alias(Reports::class, 'Google_Service_Doubleclicksearch_Resource_Reports');
89