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\ShoppingContent\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\ShoppingContent\ListRepricingRuleReportsResponse;
|
---|
21 |
|
---|
22 | /**
|
---|
23 | * The "repricingreports" collection of methods.
|
---|
24 | * Typical usage is:
|
---|
25 | * <code>
|
---|
26 | * $contentService = new Google\Service\ShoppingContent(...);
|
---|
27 | * $repricingreports = $contentService->repricingrules_repricingreports;
|
---|
28 | * </code>
|
---|
29 | */
|
---|
30 | class RepricingrulesRepricingreports extends \Google\Service\Resource
|
---|
31 | {
|
---|
32 | /**
|
---|
33 | * *Deprecated*: New merchants can't start using this service. Lists the metrics
|
---|
34 | * report for a given Repricing rule.
|
---|
35 | * (repricingreports.listRepricingrulesRepricingreports)
|
---|
36 | *
|
---|
37 | * @param string $merchantId Required. Id of the merchant who owns the Repricing
|
---|
38 | * rule.
|
---|
39 | * @param string $ruleId Required. Id of the Repricing rule.
|
---|
40 | * @param array $optParams Optional parameters.
|
---|
41 | *
|
---|
42 | * @opt_param string endDate Gets Repricing reports on and before this date in
|
---|
43 | * the merchant's timezone. You can only retrieve data up to 7 days ago
|
---|
44 | * (default) or earlier. Format: YYYY-MM-DD.
|
---|
45 | * @opt_param int pageSize Maximum number of daily reports to return. Each
|
---|
46 | * report includes data from a single 24-hour period. The page size defaults to
|
---|
47 | * 50 and values above 1000 are coerced to 1000. This service may return fewer
|
---|
48 | * days than this value, for example, if the time between your start and end
|
---|
49 | * date is less than page size.
|
---|
50 | * @opt_param string pageToken Token (if provided) to retrieve the subsequent
|
---|
51 | * page. All other parameters must match the original call that provided the
|
---|
52 | * page token.
|
---|
53 | * @opt_param string startDate Gets Repricing reports on and after this date in
|
---|
54 | * the merchant's timezone, up to one year ago. Do not use a start date later
|
---|
55 | * than 7 days ago (default). Format: YYYY-MM-DD.
|
---|
56 | * @return ListRepricingRuleReportsResponse
|
---|
57 | */
|
---|
58 | public function listRepricingrulesRepricingreports($merchantId, $ruleId, $optParams = [])
|
---|
59 | {
|
---|
60 | $params = ['merchantId' => $merchantId, 'ruleId' => $ruleId];
|
---|
61 | $params = array_merge($params, $optParams);
|
---|
62 | return $this->call('list', [$params], ListRepricingRuleReportsResponse::class);
|
---|
63 | }
|
---|
64 | }
|
---|
65 |
|
---|
66 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
67 | class_alias(RepricingrulesRepricingreports::class, 'Google_Service_ShoppingContent_Resource_RepricingrulesRepricingreports');
|
---|