source: vendor/google/apiclient-services/src/Dfareporting/Resource/PlacementStrategies.php

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

Upload project files

  • Property mode set to 100644
File size: 5.7 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\Dfareporting\Resource;
19
20use Google\Service\Dfareporting\PlacementStrategiesListResponse;
21use Google\Service\Dfareporting\PlacementStrategy;
22
23/**
24 * The "placementStrategies" collection of methods.
25 * Typical usage is:
26 * <code>
27 * $dfareportingService = new Google\Service\Dfareporting(...);
28 * $placementStrategies = $dfareportingService->placementStrategies;
29 * </code>
30 */
31class PlacementStrategies extends \Google\Service\Resource
32{
33 /**
34 * Deletes an existing placement strategy. (placementStrategies.delete)
35 *
36 * @param string $profileId User profile ID associated with this request.
37 * @param string $id Placement strategy ID.
38 * @param array $optParams Optional parameters.
39 * @throws \Google\Service\Exception
40 */
41 public function delete($profileId, $id, $optParams = [])
42 {
43 $params = ['profileId' => $profileId, 'id' => $id];
44 $params = array_merge($params, $optParams);
45 return $this->call('delete', [$params]);
46 }
47 /**
48 * Gets one placement strategy by ID. (placementStrategies.get)
49 *
50 * @param string $profileId User profile ID associated with this request.
51 * @param string $id Placement strategy ID.
52 * @param array $optParams Optional parameters.
53 * @return PlacementStrategy
54 * @throws \Google\Service\Exception
55 */
56 public function get($profileId, $id, $optParams = [])
57 {
58 $params = ['profileId' => $profileId, 'id' => $id];
59 $params = array_merge($params, $optParams);
60 return $this->call('get', [$params], PlacementStrategy::class);
61 }
62 /**
63 * Inserts a new placement strategy. (placementStrategies.insert)
64 *
65 * @param string $profileId User profile ID associated with this request.
66 * @param PlacementStrategy $postBody
67 * @param array $optParams Optional parameters.
68 * @return PlacementStrategy
69 * @throws \Google\Service\Exception
70 */
71 public function insert($profileId, PlacementStrategy $postBody, $optParams = [])
72 {
73 $params = ['profileId' => $profileId, 'postBody' => $postBody];
74 $params = array_merge($params, $optParams);
75 return $this->call('insert', [$params], PlacementStrategy::class);
76 }
77 /**
78 * Retrieves a list of placement strategies, possibly filtered. This method
79 * supports paging. (placementStrategies.listPlacementStrategies)
80 *
81 * @param string $profileId User profile ID associated with this request.
82 * @param array $optParams Optional parameters.
83 *
84 * @opt_param string ids Select only placement strategies with these IDs.
85 * @opt_param int maxResults Maximum number of results to return.
86 * @opt_param string pageToken Value of the nextPageToken from the previous
87 * result page.
88 * @opt_param string searchString Allows searching for objects by name or ID.
89 * Wildcards (*) are allowed. For example, "placementstrategy*2015" will return
90 * objects with names like "placementstrategy June 2015", "placementstrategy
91 * April 2015", or simply "placementstrategy 2015". Most of the searches also
92 * add wildcards implicitly at the start and the end of the search string. For
93 * example, a search string of "placementstrategy" will match objects with name
94 * "my placementstrategy", "placementstrategy 2015", or simply
95 * "placementstrategy".
96 * @opt_param string sortField Field by which to sort the list.
97 * @opt_param string sortOrder Order of sorted results.
98 * @return PlacementStrategiesListResponse
99 * @throws \Google\Service\Exception
100 */
101 public function listPlacementStrategies($profileId, $optParams = [])
102 {
103 $params = ['profileId' => $profileId];
104 $params = array_merge($params, $optParams);
105 return $this->call('list', [$params], PlacementStrategiesListResponse::class);
106 }
107 /**
108 * Updates an existing placement strategy. This method supports patch semantics.
109 * (placementStrategies.patch)
110 *
111 * @param string $profileId User profile ID associated with this request.
112 * @param string $id Required. PlacementStrategy ID.
113 * @param PlacementStrategy $postBody
114 * @param array $optParams Optional parameters.
115 * @return PlacementStrategy
116 * @throws \Google\Service\Exception
117 */
118 public function patch($profileId, $id, PlacementStrategy $postBody, $optParams = [])
119 {
120 $params = ['profileId' => $profileId, 'id' => $id, 'postBody' => $postBody];
121 $params = array_merge($params, $optParams);
122 return $this->call('patch', [$params], PlacementStrategy::class);
123 }
124 /**
125 * Updates an existing placement strategy. (placementStrategies.update)
126 *
127 * @param string $profileId User profile ID associated with this request.
128 * @param PlacementStrategy $postBody
129 * @param array $optParams Optional parameters.
130 * @return PlacementStrategy
131 * @throws \Google\Service\Exception
132 */
133 public function update($profileId, PlacementStrategy $postBody, $optParams = [])
134 {
135 $params = ['profileId' => $profileId, 'postBody' => $postBody];
136 $params = array_merge($params, $optParams);
137 return $this->call('update', [$params], PlacementStrategy::class);
138 }
139}
140
141// Adding a class alias for backwards compatibility with the previous class name.
142class_alias(PlacementStrategies::class, 'Google_Service_Dfareporting_Resource_PlacementStrategies');
Note: See TracBrowser for help on using the repository browser.