📄 Source: TargetingTypesTargetingOptions.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\DisplayVideo\Resource;
use Google\Service\DisplayVideo\ListTargetingOptionsResponse;
use Google\Service\DisplayVideo\SearchTargetingOptionsRequest;
use Google\Service\DisplayVideo\SearchTargetingOptionsResponse;
use Google\Service\DisplayVideo\TargetingOption;
/**
* The "targetingOptions" collection of methods.
* Typical usage is:
* <code>
* $displayvideoService = new Google\Service\DisplayVideo(...);
* $targetingOptions = $displayvideoService->targetingTypes_targetingOptions;
* </code>
*/
class TargetingTypesTargetingOptions extends \Google\Service\Resource
{
/**
* Gets a single targeting option. (targetingOptions.get)
*
* @param string $targetingType Required. The type of targeting option to
* retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` *
* `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` *
* `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` *
* `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`
* * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE`
* * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` *
* `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` *
* `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` *
* `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` *
* `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` *
* `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` *
* `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` *
* `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` *
* `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` *
* `TARGETING_TYPE_OMID`
* @param string $targetingOptionId Required. The ID of the of targeting option
* to retrieve.
* @param array $optParams Optional parameters.
*
* @opt_param string advertiserId Required. The Advertiser this request is being
* made in the context of.
* @return TargetingOption
* @throws \Google\Service\Exception
*/
public function get($targetingType, $targetingOptionId, $optParams = [])
{
$params = ['targetingType' => $targetingType, 'targetingOptionId' => $targetingOptionId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], TargetingOption::class);
}
/**
* Lists targeting options of a given type.
* (targetingOptions.listTargetingTypesTargetingOptions)
*
* @param string $targetingType Required. The type of targeting option to be
* listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` *
* `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` *
* `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` *
* `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`
* * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE`
* * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` *
* `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` *
* `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` *
* `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` *
* `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` *
* `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` *
* `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` *
* `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` *
* `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` *
* `TARGETING_TYPE_OMID`
* @param array $optParams Optional parameters.
*
* @opt_param string advertiserId Required. The Advertiser this request is being
* made in the context of.
* @opt_param string filter Allows filtering by targeting option fields.
* Supported syntax: * Filter expressions are made up of one or more
* restrictions. * Restrictions can be combined by `OR` logical operators. * A
* restriction has the form of `{field} {operator} {value}`. * All fields must
* use the `EQUALS (=)` operator. Supported fields: *
* `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` *
* `targetingOptionId` Examples: * All `GEO REGION` targeting options that
* belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`:
* `geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR
* geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND
* ISP` targeting options that belong to sub type
* `CARRIER_AND_ISP_TYPE_CARRIER`:
* `carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this
* field should be no more than 500 characters. Reference our [filter `LIST`
* requests](/display-video/api/guides/how-tos/filters) guide for more
* information.
* @opt_param string orderBy Field by which to sort the list. Acceptable values
* are: * `targetingOptionId` (default) The default sorting order is ascending.
* To specify descending order for a field, a suffix "desc" should be added to
* the field name. Example: `targetingOptionId desc`.
* @opt_param int pageSize Requested page size. Must be between `1` and `200`.
* If unspecified will default to `100`. 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 `ListTargetingOptions` method. If not specified, the
* first page of results will be returned.
* @return ListTargetingOptionsResponse
* @throws \Google\Service\Exception
*/
public function listTargetingTypesTargetingOptions($targetingType, $optParams = [])
{
$params = ['targetingType' => $targetingType];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListTargetingOptionsResponse::class);
}
/**
* Searches for targeting options of a given type based on the given search
* terms. (targetingOptions.search)
*
* @param string $targetingType Required. The type of targeting options to
* retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` *
* `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN`
* @param SearchTargetingOptionsRequest $postBody
* @param array $optParams Optional parameters.
* @return SearchTargetingOptionsResponse
* @throws \Google\Service\Exception
*/
public function search($targetingType, SearchTargetingOptionsRequest $postBody, $optParams = [])
{
$params = ['targetingType' => $targetingType, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('search', [$params], SearchTargetingOptionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TargetingTypesTargetingOptions::class, 'Google_Service_DisplayVideo_Resource_TargetingTypesTargetingOptions');
← Back