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\MyBusinessBusinessCalls\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\MyBusinessBusinessCalls\ListBusinessCallsInsightsResponse;
|
---|
21 |
|
---|
22 | /**
|
---|
23 | * The "businesscallsinsights" collection of methods.
|
---|
24 | * Typical usage is:
|
---|
25 | * <code>
|
---|
26 | * $mybusinessbusinesscallsService = new Google\Service\MyBusinessBusinessCalls(...);
|
---|
27 | * $businesscallsinsights = $mybusinessbusinesscallsService->locations_businesscallsinsights;
|
---|
28 | * </code>
|
---|
29 | */
|
---|
30 | class LocationsBusinesscallsinsights extends \Google\Service\Resource
|
---|
31 | {
|
---|
32 | /**
|
---|
33 | * Returns insights for Business calls for a location.
|
---|
34 | * (businesscallsinsights.listLocationsBusinesscallsinsights)
|
---|
35 | *
|
---|
36 | * @param string $parent Required. The parent location to fetch calls insights
|
---|
37 | * for. Format: locations/{location_id}
|
---|
38 | * @param array $optParams Optional parameters.
|
---|
39 | *
|
---|
40 | * @opt_param string filter Optional. A filter constraining the calls insights
|
---|
41 | * to return. The response includes only entries that match the filter. If the
|
---|
42 | * MetricType is not provided, AGGREGATE_COUNT is returned. If no end_date is
|
---|
43 | * provided, the last date for which data is available is used. If no start_date
|
---|
44 | * is provided, we will default to the first date for which data is available,
|
---|
45 | * which is currently 6 months. If start_date is before the date when data is
|
---|
46 | * available, data is returned starting from the date when it is available. At
|
---|
47 | * this time we support following filters. 1. start_date="DATE" where date is in
|
---|
48 | * YYYY-MM-DD format. 2. end_date="DATE" where date is in YYYY-MM-DD format. 3.
|
---|
49 | * metric_type=XYZ where XYZ is a valid MetricType. 4. Conjunctions(AND) of all
|
---|
50 | * of the above. e.g., "start_date=2021-08-01 AND end_date=2021-08-10 AND
|
---|
51 | * metric_type=AGGREGATE_COUNT" The AGGREGATE_COUNT metric_type ignores the DD
|
---|
52 | * part of the date.
|
---|
53 | * @opt_param int pageSize Optional. The maximum number of BusinessCallsInsights
|
---|
54 | * to return. If unspecified, at most 20 will be returned. Some of the
|
---|
55 | * metric_types(e.g, AGGREGATE_COUNT) returns a single page. For these metrics,
|
---|
56 | * the page_size is ignored.
|
---|
57 | * @opt_param string pageToken Optional. A page token, received from a previous
|
---|
58 | * `ListBusinessCallsInsights` call. Provide this to retrieve the subsequent
|
---|
59 | * page. When paginating, all other parameters provided to
|
---|
60 | * `ListBusinessCallsInsights` must match the call that provided the page token.
|
---|
61 | * Some of the metric_types (e.g, AGGREGATE_COUNT) returns a single page. For
|
---|
62 | * these metrics, the pake_token is ignored.
|
---|
63 | * @return ListBusinessCallsInsightsResponse
|
---|
64 | */
|
---|
65 | public function listLocationsBusinesscallsinsights($parent, $optParams = [])
|
---|
66 | {
|
---|
67 | $params = ['parent' => $parent];
|
---|
68 | $params = array_merge($params, $optParams);
|
---|
69 | return $this->call('list', [$params], ListBusinessCallsInsightsResponse::class);
|
---|
70 | }
|
---|
71 | }
|
---|
72 |
|
---|
73 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
74 | class_alias(LocationsBusinesscallsinsights::class, 'Google_Service_MyBusinessBusinessCalls_Resource_LocationsBusinesscallsinsights');
|
---|