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\Webmasters\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Webmasters\SearchAnalyticsQueryRequest;
|
---|
21 | use Google\Service\Webmasters\SearchAnalyticsQueryResponse;
|
---|
22 |
|
---|
23 | /**
|
---|
24 | * The "searchanalytics" collection of methods.
|
---|
25 | * Typical usage is:
|
---|
26 | * <code>
|
---|
27 | * $webmastersService = new Google\Service\Webmasters(...);
|
---|
28 | * $searchanalytics = $webmastersService->searchanalytics;
|
---|
29 | * </code>
|
---|
30 | */
|
---|
31 | class Searchanalytics extends \Google\Service\Resource
|
---|
32 | {
|
---|
33 | /**
|
---|
34 | * Query your data with filters and parameters that you define. Returns zero or
|
---|
35 | * more rows grouped by the row keys that you define. You must define a date
|
---|
36 | * range of one or more days.
|
---|
37 | *
|
---|
38 | * When date is one of the group by values, any days without data are omitted
|
---|
39 | * from the result list. If you need to know which days have data, issue a broad
|
---|
40 | * date range query grouped by date for any metric, and see which day rows are
|
---|
41 | * returned. (searchanalytics.query)
|
---|
42 | *
|
---|
43 | * @param string $siteUrl The site's URL, including protocol. For example:
|
---|
44 | * http://www.example.com/
|
---|
45 | * @param SearchAnalyticsQueryRequest $postBody
|
---|
46 | * @param array $optParams Optional parameters.
|
---|
47 | * @return SearchAnalyticsQueryResponse
|
---|
48 | */
|
---|
49 | public function query($siteUrl, SearchAnalyticsQueryRequest $postBody, $optParams = [])
|
---|
50 | {
|
---|
51 | $params = ['siteUrl' => $siteUrl, 'postBody' => $postBody];
|
---|
52 | $params = array_merge($params, $optParams);
|
---|
53 | return $this->call('query', [$params], SearchAnalyticsQueryResponse::class);
|
---|
54 | }
|
---|
55 | }
|
---|
56 |
|
---|
57 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
58 | class_alias(Searchanalytics::class, 'Google_Service_Webmasters_Resource_Searchanalytics');
|
---|