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