* $displayvideoService = new Google\Service\DisplayVideo(...); * $locationLists = $displayvideoService->locationLists; * */ class AdvertisersLocationLists extends \Google\Service\Resource { /** * Creates a new location list. Returns the newly created location list if * successful. (locationLists.create) * * @param string $advertiserId Required. The ID of the DV360 advertiser to which * the location list belongs. * @param LocationList $postBody * @param array $optParams Optional parameters. * @return LocationList */ public function create($advertiserId, LocationList $postBody, $optParams = []) { $params = ['advertiserId' => $advertiserId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], LocationList::class); } /** * Gets a location list. (locationLists.get) * * @param string $advertiserId Required. The ID of the DV360 advertiser to which * the fetched location list belongs. * @param string $locationListId Required. The ID of the location list to fetch. * @param array $optParams Optional parameters. * @return LocationList */ public function get($advertiserId, $locationListId, $optParams = []) { $params = ['advertiserId' => $advertiserId, 'locationListId' => $locationListId]; $params = array_merge($params, $optParams); return $this->call('get', [$params], LocationList::class); } /** * Lists location lists based on a given advertiser id. * (locationLists.listAdvertisersLocationLists) * * @param string $advertiserId Required. The ID of the DV360 advertiser to which * the fetched location lists belong. * @param array $optParams Optional parameters. * * @opt_param string filter Allows filtering by location list fields. Supported * syntax: * Filter expressions are made up of one or more restrictions. * * Restrictions can be combined by `AND` or `OR` logical operators. A sequence * of restrictions implicitly uses `AND`. * A restriction has the form of * `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * * Supported fields: - `locationType` Examples: * All regional location list: * `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location * list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` * @opt_param string orderBy Field by which to sort the list. Acceptable values * are: * `locationListId` (default) * `displayName` The default sorting order * is ascending. To specify descending order for a field, a suffix "desc" should * be added to the field name. Example: `displayName desc`. * @opt_param int pageSize Requested page size. Must be between `1` and `100`. * Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an * invalid value is specified. * @opt_param string pageToken A token identifying a page of results the server * should return. Typically, this is the value of next_page_token returned from * the previous call to `ListLocationLists` method. If not specified, the first * page of results will be returned. * @return ListLocationListsResponse */ public function listAdvertisersLocationLists($advertiserId, $optParams = []) { $params = ['advertiserId' => $advertiserId]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListLocationListsResponse::class); } /** * Updates a location list. Returns the updated location list if successful. * (locationLists.patch) * * @param string $advertiserId Required. The ID of the DV360 advertiser to which * the location lists belongs. * @param string $locationListId Output only. The unique ID of the location * list. Assigned by the system. * @param LocationList $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask Required. The mask to control which fields to * update. * @return LocationList */ public function patch($advertiserId, $locationListId, LocationList $postBody, $optParams = []) { $params = ['advertiserId' => $advertiserId, 'locationListId' => $locationListId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], LocationList::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(AdvertisersLocationLists::class, 'Google_Service_DisplayVideo_Resource_AdvertisersLocationLists');