source: vendor/google/apiclient-services/src/Analytics/Resource/ManagementRemarketingAudience.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 2 weeks ago

Upload project files

  • Property mode set to 100644
File size: 6.5 KB
Line 
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
18namespace Google\Service\Analytics\Resource;
19
20use Google\Service\Analytics\RemarketingAudience;
21use Google\Service\Analytics\RemarketingAudiences;
22
23/**
24 * The "remarketingAudience" collection of methods.
25 * Typical usage is:
26 * <code>
27 * $analyticsService = new Google\Service\Analytics(...);
28 * $remarketingAudience = $analyticsService->management_remarketingAudience;
29 * </code>
30 */
31class ManagementRemarketingAudience extends \Google\Service\Resource
32{
33 /**
34 * Delete a remarketing audience. (remarketingAudience.delete)
35 *
36 * @param string $accountId Account ID to which the remarketing audience
37 * belongs.
38 * @param string $webPropertyId Web property ID to which the remarketing
39 * audience belongs.
40 * @param string $remarketingAudienceId The ID of the remarketing audience to
41 * delete.
42 * @param array $optParams Optional parameters.
43 * @throws \Google\Service\Exception
44 */
45 public function delete($accountId, $webPropertyId, $remarketingAudienceId, $optParams = [])
46 {
47 $params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'remarketingAudienceId' => $remarketingAudienceId];
48 $params = array_merge($params, $optParams);
49 return $this->call('delete', [$params]);
50 }
51 /**
52 * Gets a remarketing audience to which the user has access.
53 * (remarketingAudience.get)
54 *
55 * @param string $accountId The account ID of the remarketing audience to
56 * retrieve.
57 * @param string $webPropertyId The web property ID of the remarketing audience
58 * to retrieve.
59 * @param string $remarketingAudienceId The ID of the remarketing audience to
60 * retrieve.
61 * @param array $optParams Optional parameters.
62 * @return RemarketingAudience
63 * @throws \Google\Service\Exception
64 */
65 public function get($accountId, $webPropertyId, $remarketingAudienceId, $optParams = [])
66 {
67 $params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'remarketingAudienceId' => $remarketingAudienceId];
68 $params = array_merge($params, $optParams);
69 return $this->call('get', [$params], RemarketingAudience::class);
70 }
71 /**
72 * Creates a new remarketing audience. (remarketingAudience.insert)
73 *
74 * @param string $accountId The account ID for which to create the remarketing
75 * audience.
76 * @param string $webPropertyId Web property ID for which to create the
77 * remarketing audience.
78 * @param RemarketingAudience $postBody
79 * @param array $optParams Optional parameters.
80 * @return RemarketingAudience
81 * @throws \Google\Service\Exception
82 */
83 public function insert($accountId, $webPropertyId, RemarketingAudience $postBody, $optParams = [])
84 {
85 $params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'postBody' => $postBody];
86 $params = array_merge($params, $optParams);
87 return $this->call('insert', [$params], RemarketingAudience::class);
88 }
89 /**
90 * Lists remarketing audiences to which the user has access.
91 * (remarketingAudience.listManagementRemarketingAudience)
92 *
93 * @param string $accountId The account ID of the remarketing audiences to
94 * retrieve.
95 * @param string $webPropertyId The web property ID of the remarketing audiences
96 * to retrieve.
97 * @param array $optParams Optional parameters.
98 *
99 * @opt_param int max-results The maximum number of remarketing audiences to
100 * include in this response.
101 * @opt_param int start-index An index of the first entity to retrieve. Use this
102 * parameter as a pagination mechanism along with the max-results parameter.
103 * @opt_param string type
104 * @return RemarketingAudiences
105 * @throws \Google\Service\Exception
106 */
107 public function listManagementRemarketingAudience($accountId, $webPropertyId, $optParams = [])
108 {
109 $params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId];
110 $params = array_merge($params, $optParams);
111 return $this->call('list', [$params], RemarketingAudiences::class);
112 }
113 /**
114 * Updates an existing remarketing audience. This method supports patch
115 * semantics. (remarketingAudience.patch)
116 *
117 * @param string $accountId The account ID of the remarketing audience to
118 * update.
119 * @param string $webPropertyId The web property ID of the remarketing audience
120 * to update.
121 * @param string $remarketingAudienceId The ID of the remarketing audience to
122 * update.
123 * @param RemarketingAudience $postBody
124 * @param array $optParams Optional parameters.
125 * @return RemarketingAudience
126 * @throws \Google\Service\Exception
127 */
128 public function patch($accountId, $webPropertyId, $remarketingAudienceId, RemarketingAudience $postBody, $optParams = [])
129 {
130 $params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'remarketingAudienceId' => $remarketingAudienceId, 'postBody' => $postBody];
131 $params = array_merge($params, $optParams);
132 return $this->call('patch', [$params], RemarketingAudience::class);
133 }
134 /**
135 * Updates an existing remarketing audience. (remarketingAudience.update)
136 *
137 * @param string $accountId The account ID of the remarketing audience to
138 * update.
139 * @param string $webPropertyId The web property ID of the remarketing audience
140 * to update.
141 * @param string $remarketingAudienceId The ID of the remarketing audience to
142 * update.
143 * @param RemarketingAudience $postBody
144 * @param array $optParams Optional parameters.
145 * @return RemarketingAudience
146 * @throws \Google\Service\Exception
147 */
148 public function update($accountId, $webPropertyId, $remarketingAudienceId, RemarketingAudience $postBody, $optParams = [])
149 {
150 $params = ['accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'remarketingAudienceId' => $remarketingAudienceId, 'postBody' => $postBody];
151 $params = array_merge($params, $optParams);
152 return $this->call('update', [$params], RemarketingAudience::class);
153 }
154}
155
156// Adding a class alias for backwards compatibility with the previous class name.
157class_alias(ManagementRemarketingAudience::class, 'Google_Service_Analytics_Resource_ManagementRemarketingAudience');
Note: See TracBrowser for help on using the repository browser.