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