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/**
19 * The "targetableRemarketingLists" collection of methods.
20 * Typical usage is:
21 *  <code>
22 *   $dfareportingService = new Google_Service_Dfareporting(...);
23 *   $targetableRemarketingLists = $dfareportingService->targetableRemarketingLists;
24 *  </code>
25 */
26class Google_Service_Dfareporting_Resource_TargetableRemarketingLists extends Google_Service_Resource
27{
28  /**
29   * Gets one remarketing list by ID. (targetableRemarketingLists.get)
30   *
31   * @param string $profileId User profile ID associated with this request.
32   * @param string $id Remarketing list ID.
33   * @param array $optParams Optional parameters.
34   * @return Google_Service_Dfareporting_TargetableRemarketingList
35   */
36  public function get($profileId, $id, $optParams = array())
37  {
38    $params = array('profileId' => $profileId, 'id' => $id);
39    $params = array_merge($params, $optParams);
40    return $this->call('get', array($params), "Google_Service_Dfareporting_TargetableRemarketingList");
41  }
42  /**
43   * Retrieves a list of targetable remarketing lists, possibly filtered. This
44   * method supports paging.
45   * (targetableRemarketingLists.listTargetableRemarketingLists)
46   *
47   * @param string $profileId User profile ID associated with this request.
48   * @param string $advertiserId Select only targetable remarketing lists
49   * targetable by these advertisers.
50   * @param array $optParams Optional parameters.
51   *
52   * @opt_param bool active Select only active or only inactive targetable
53   * remarketing lists.
54   * @opt_param int maxResults Maximum number of results to return.
55   * @opt_param string name Allows searching for objects by name or ID. Wildcards
56   * (*) are allowed. For example, "remarketing list*2015" will return objects
57   * with names like "remarketing list June 2015", "remarketing list April 2015",
58   * or simply "remarketing list 2015". Most of the searches also add wildcards
59   * implicitly at the start and the end of the search string. For example, a
60   * search string of "remarketing list" will match objects with name "my
61   * remarketing list", "remarketing list 2015", or simply "remarketing list".
62   * @opt_param string pageToken Value of the nextPageToken from the previous
63   * result page.
64   * @opt_param string sortField Field by which to sort the list.
65   * @opt_param string sortOrder Order of sorted results.
66   * @return Google_Service_Dfareporting_TargetableRemarketingListsListResponse
67   */
68  public function listTargetableRemarketingLists($profileId, $advertiserId, $optParams = array())
69  {
70    $params = array('profileId' => $profileId, 'advertiserId' => $advertiserId);
71    $params = array_merge($params, $optParams);
72    return $this->call('list', array($params), "Google_Service_Dfareporting_TargetableRemarketingListsListResponse");
73  }
74}
75