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\Size;
21use Google\Service\Dfareporting\SizesListResponse;
22
23/**
24 * The "sizes" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $dfareportingService = new Google\Service\Dfareporting(...);
28 *   $sizes = $dfareportingService->sizes;
29 *  </code>
30 */
31class Sizes extends \Google\Service\Resource
32{
33  /**
34   * Gets one size by ID. (sizes.get)
35   *
36   * @param string $profileId User profile ID associated with this request.
37   * @param string $id Size ID.
38   * @param array $optParams Optional parameters.
39   * @return Size
40   */
41  public function get($profileId, $id, $optParams = [])
42  {
43    $params = ['profileId' => $profileId, 'id' => $id];
44    $params = array_merge($params, $optParams);
45    return $this->call('get', [$params], Size::class);
46  }
47  /**
48   * Inserts a new size. (sizes.insert)
49   *
50   * @param string $profileId User profile ID associated with this request.
51   * @param Size $postBody
52   * @param array $optParams Optional parameters.
53   * @return Size
54   */
55  public function insert($profileId, Size $postBody, $optParams = [])
56  {
57    $params = ['profileId' => $profileId, 'postBody' => $postBody];
58    $params = array_merge($params, $optParams);
59    return $this->call('insert', [$params], Size::class);
60  }
61  /**
62   * Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally
63   * unique and may include values not currently in use by your account. Due to
64   * this, the list of sizes returned by this method may differ from the list seen
65   * in the Trafficking UI. (sizes.listSizes)
66   *
67   * @param string $profileId User profile ID associated with this request.
68   * @param array $optParams Optional parameters.
69   *
70   * @opt_param int height Select only sizes with this height.
71   * @opt_param bool iabStandard Select only IAB standard sizes.
72   * @opt_param string ids Select only sizes with these IDs.
73   * @opt_param int width Select only sizes with this width.
74   * @return SizesListResponse
75   */
76  public function listSizes($profileId, $optParams = [])
77  {
78    $params = ['profileId' => $profileId];
79    $params = array_merge($params, $optParams);
80    return $this->call('list', [$params], SizesListResponse::class);
81  }
82}
83
84// Adding a class alias for backwards compatibility with the previous class name.
85class_alias(Sizes::class, 'Google_Service_Dfareporting_Resource_Sizes');
86