📄 Source: AdvertisersTargetingTypesAssignedTargetingOptions.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\AssignedTargetingOption;
use Google\Service\DisplayVideo\DisplayvideoEmpty;
use Google\Service\DisplayVideo\ListAdvertiserAssignedTargetingOptionsResponse;
/**
* The "assignedTargetingOptions" collection of methods.
* Typical usage is:
* <code>
* $displayvideoService = new Google\Service\DisplayVideo(...);
* $assignedTargetingOptions = $displayvideoService->advertisers_targetingTypes_assignedTargetingOptions;
* </code>
*/
class AdvertisersTargetingTypesAssignedTargetingOptions extends \Google\Service\Resource
{
/**
* Assigns a targeting option to an advertiser. Returns the assigned targeting
* option if successful. (assignedTargetingOptions.create)
*
* @param string $advertiserId Required. The ID of the advertiser.
* @param string $targetingType Required. Identifies the type of this assigned
* targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` *
* `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` *
* `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
* @param AssignedTargetingOption $postBody
* @param array $optParams Optional parameters.
* @return AssignedTargetingOption
* @throws \Google\Service\Exception
*/
public function create($advertiserId, $targetingType, AssignedTargetingOption $postBody, $optParams = [])
{
$params = ['advertiserId' => $advertiserId, 'targetingType' => $targetingType, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], AssignedTargetingOption::class);
}
/**
* Deletes an assigned targeting option from an advertiser.
* (assignedTargetingOptions.delete)
*
* @param string $advertiserId Required. The ID of the advertiser.
* @param string $targetingType Required. Identifies the type of this assigned
* targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` *
* `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` *
* `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`
* @param string $assignedTargetingOptionId Required. The ID of the assigned
* targeting option to delete.
* @param array $optParams Optional parameters.
* @return DisplayvideoEmpty
* @throws \Google\Service\Exception
*/
public function delete($advertiserId, $targetingType, $assignedTargetingOptionId, $optParams = [])
{
$params = ['advertiserId' => $advertiserId, 'targetingType' => $targetingType, 'assignedTargetingOptionId' => $assignedTargetingOptionId];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], DisplayvideoEmpty::class);
}
/**
* Gets a single targeting option assigned to an advertiser.
* (assignedTargetingOptions.get)
*
* @param string $advertiserId Required. The ID of the advertiser.
* @param string $targetingType Required. Identifies the type of this assigned
* targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` *
* `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` *
* `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` *
* `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` *
* `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`
* @param string $assignedTargetingOptionId Required. An identifier unique to
* the targeting type in this advertiser that identifies the assigned targeting
* option being requested.
* @param array $optParams Optional parameters.
* @return AssignedTargetingOption
* @throws \Google\Service\Exception
*/
public function get($advertiserId, $targetingType, $assignedTargetingOptionId, $optParams = [])
{
$params = ['advertiserId' => $advertiserId, 'targetingType' => $targetingType, 'assignedTargetingOptionId' => $assignedTargetingOptionId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], AssignedTargetingOption::class);
}
/**
* Lists the targeting options assigned to an advertiser. (assignedTargetingOpti
* ons.listAdvertisersTargetingTypesAssignedTargetingOptions)
*
* @param string $advertiserId Required. The ID of the advertiser.
* @param string $targetingType Required. Identifies the type of assigned
* targeting options to list. Supported targeting types: *
* `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` *
* `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` *
* `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL` *
* `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`
* @param array $optParams Optional parameters.
*
* @opt_param string filter Allows filtering by assigned targeting option
* fields. Supported syntax: * Filter expressions are made up of one or more
* restrictions. * Restrictions can be combined by the `OR` logical operator. *
* A restriction has the form of `{field} {operator} {value}`. * All fields must
* use the `EQUALS (=)` operator. Supported fields: *
* `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID
* 123456: `assignedTargetingOptionId="123456"` 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: * `assignedTargetingOptionId` (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: `assignedTargetingOptionId desc`.
* @opt_param int pageSize Requested page size. Must be between `1` and `5000`.
* 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 `ListAdvertiserAssignedTargetingOptions` method. If not
* specified, the first page of results will be returned.
* @return ListAdvertiserAssignedTargetingOptionsResponse
* @throws \Google\Service\Exception
*/
public function listAdvertisersTargetingTypesAssignedTargetingOptions($advertiserId, $targetingType, $optParams = [])
{
$params = ['advertiserId' => $advertiserId, 'targetingType' => $targetingType];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListAdvertiserAssignedTargetingOptionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AdvertisersTargetingTypesAssignedTargetingOptions::class, 'Google_Service_DisplayVideo_Resource_AdvertisersTargetingTypesAssignedTargetingOptions');
← Back