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