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\GoogleAnalyticsAdmin\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1betaConversionEvent;
|
---|
21 | use Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1betaListConversionEventsResponse;
|
---|
22 | use Google\Service\GoogleAnalyticsAdmin\GoogleProtobufEmpty;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The "conversionEvents" collection of methods.
|
---|
26 | * Typical usage is:
|
---|
27 | * <code>
|
---|
28 | * $analyticsadminService = new Google\Service\GoogleAnalyticsAdmin(...);
|
---|
29 | * $conversionEvents = $analyticsadminService->properties_conversionEvents;
|
---|
30 | * </code>
|
---|
31 | */
|
---|
32 | class PropertiesConversionEvents extends \Google\Service\Resource
|
---|
33 | {
|
---|
34 | /**
|
---|
35 | * Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the
|
---|
36 | * specified attributes. (conversionEvents.create)
|
---|
37 | *
|
---|
38 | * @param string $parent Required. The resource name of the parent property
|
---|
39 | * where this conversion event will be created. Format: properties/123
|
---|
40 | * @param GoogleAnalyticsAdminV1betaConversionEvent $postBody
|
---|
41 | * @param array $optParams Optional parameters.
|
---|
42 | * @return GoogleAnalyticsAdminV1betaConversionEvent
|
---|
43 | * @throws \Google\Service\Exception
|
---|
44 | */
|
---|
45 | public function create($parent, GoogleAnalyticsAdminV1betaConversionEvent $postBody, $optParams = [])
|
---|
46 | {
|
---|
47 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
48 | $params = array_merge($params, $optParams);
|
---|
49 | return $this->call('create', [$params], GoogleAnalyticsAdminV1betaConversionEvent::class);
|
---|
50 | }
|
---|
51 | /**
|
---|
52 | * Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a
|
---|
53 | * property. (conversionEvents.delete)
|
---|
54 | *
|
---|
55 | * @param string $name Required. The resource name of the conversion event to
|
---|
56 | * delete. Format: properties/{property}/conversionEvents/{conversion_event}
|
---|
57 | * Example: "properties/123/conversionEvents/456"
|
---|
58 | * @param array $optParams Optional parameters.
|
---|
59 | * @return GoogleProtobufEmpty
|
---|
60 | * @throws \Google\Service\Exception
|
---|
61 | */
|
---|
62 | public function delete($name, $optParams = [])
|
---|
63 | {
|
---|
64 | $params = ['name' => $name];
|
---|
65 | $params = array_merge($params, $optParams);
|
---|
66 | return $this->call('delete', [$params], GoogleProtobufEmpty::class);
|
---|
67 | }
|
---|
68 | /**
|
---|
69 | * Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.
|
---|
70 | * (conversionEvents.get)
|
---|
71 | *
|
---|
72 | * @param string $name Required. The resource name of the conversion event to
|
---|
73 | * retrieve. Format: properties/{property}/conversionEvents/{conversion_event}
|
---|
74 | * Example: "properties/123/conversionEvents/456"
|
---|
75 | * @param array $optParams Optional parameters.
|
---|
76 | * @return GoogleAnalyticsAdminV1betaConversionEvent
|
---|
77 | * @throws \Google\Service\Exception
|
---|
78 | */
|
---|
79 | public function get($name, $optParams = [])
|
---|
80 | {
|
---|
81 | $params = ['name' => $name];
|
---|
82 | $params = array_merge($params, $optParams);
|
---|
83 | return $this->call('get', [$params], GoogleAnalyticsAdminV1betaConversionEvent::class);
|
---|
84 | }
|
---|
85 | /**
|
---|
86 | * Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events
|
---|
87 | * in the specified parent property. Returns an empty list if no conversion
|
---|
88 | * events are found. (conversionEvents.listPropertiesConversionEvents)
|
---|
89 | *
|
---|
90 | * @param string $parent Required. The resource name of the parent property.
|
---|
91 | * Example: 'properties/123'
|
---|
92 | * @param array $optParams Optional parameters.
|
---|
93 | *
|
---|
94 | * @opt_param int pageSize The maximum number of resources to return. If
|
---|
95 | * unspecified, at most 50 resources will be returned. The maximum value is 200;
|
---|
96 | * (higher values will be coerced to the maximum)
|
---|
97 | * @opt_param string pageToken A page token, received from a previous
|
---|
98 | * `ListConversionEvents` call. Provide this to retrieve the subsequent page.
|
---|
99 | * When paginating, all other parameters provided to `ListConversionEvents` must
|
---|
100 | * match the call that provided the page token.
|
---|
101 | * @return GoogleAnalyticsAdminV1betaListConversionEventsResponse
|
---|
102 | * @throws \Google\Service\Exception
|
---|
103 | */
|
---|
104 | public function listPropertiesConversionEvents($parent, $optParams = [])
|
---|
105 | {
|
---|
106 | $params = ['parent' => $parent];
|
---|
107 | $params = array_merge($params, $optParams);
|
---|
108 | return $this->call('list', [$params], GoogleAnalyticsAdminV1betaListConversionEventsResponse::class);
|
---|
109 | }
|
---|
110 | /**
|
---|
111 | * Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the
|
---|
112 | * specified attributes. (conversionEvents.patch)
|
---|
113 | *
|
---|
114 | * @param string $name Output only. Resource name of this conversion event.
|
---|
115 | * Format: properties/{property}/conversionEvents/{conversion_event}
|
---|
116 | * @param GoogleAnalyticsAdminV1betaConversionEvent $postBody
|
---|
117 | * @param array $optParams Optional parameters.
|
---|
118 | *
|
---|
119 | * @opt_param string updateMask Required. The list of fields to be updated.
|
---|
120 | * Field names must be in snake case (e.g., "field_to_update"). Omitted fields
|
---|
121 | * will not be updated. To replace the entire entity, use one path with the
|
---|
122 | * string "*" to match all fields.
|
---|
123 | * @return GoogleAnalyticsAdminV1betaConversionEvent
|
---|
124 | * @throws \Google\Service\Exception
|
---|
125 | */
|
---|
126 | public function patch($name, GoogleAnalyticsAdminV1betaConversionEvent $postBody, $optParams = [])
|
---|
127 | {
|
---|
128 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
129 | $params = array_merge($params, $optParams);
|
---|
130 | return $this->call('patch', [$params], GoogleAnalyticsAdminV1betaConversionEvent::class);
|
---|
131 | }
|
---|
132 | }
|
---|
133 |
|
---|
134 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
135 | class_alias(PropertiesConversionEvents::class, 'Google_Service_GoogleAnalyticsAdmin_Resource_PropertiesConversionEvents');
|
---|