Documentation

Google_Service_DisplayVideo_Resource_AdvertisersNegativeKeywordListsNegativeKeywords extends Google_Service_Resource
in package

The "negativeKeywords" collection of methods.

Typical usage is: $displayvideoService = new Google_Service_DisplayVideo(...); $negativeKeywords = $displayvideoService->negativeKeywords;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
bulkEdit()  : Google_Service_DisplayVideo_BulkEditNegativeKeywordsResponse
Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure. (negativeKeywords.bulkEdit)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_DisplayVideo_NegativeKeyword
Creates a negative keyword in a negative keyword list.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DisplayVideo_DisplayvideoEmpty
Deletes a negative keyword from a negative keyword list.
listAdvertisersNegativeKeywordListsNegativeKeywords()  : Google_Service_DisplayVideo_ListNegativeKeywordsResponse
Lists negative keywords in a negative keyword list.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

bulkEdit()

Bulk edits negative keywords in a single negative keyword list. The operation will delete the negative keywords provided in BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then create the negative keywords provided in BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is guaranteed to be atomic and will never result in a partial success or partial failure. (negativeKeywords.bulkEdit)

public bulkEdit(string $advertiserId, string $negativeKeywordListId, Google_Service_DisplayVideo_BulkEditNegativeKeywordsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_BulkEditNegativeKeywordsResponse
Parameters
$advertiserId : string

Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

$negativeKeywordListId : string

Required. The ID of the parent negative keyword list to which the negative keywords belong.

$postBody : Google_Service_DisplayVideo_BulkEditNegativeKeywordsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DisplayVideo_BulkEditNegativeKeywordsResponse —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Creates a negative keyword in a negative keyword list.

public create(string $advertiserId, string $negativeKeywordListId, Google_Service_DisplayVideo_NegativeKeyword $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_NegativeKeyword

(negativeKeywords.create)

Parameters
$advertiserId : string

Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

$negativeKeywordListId : string

Required. The ID of the parent negative keyword list in which the negative keyword will be created.

$postBody : Google_Service_DisplayVideo_NegativeKeyword
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DisplayVideo_NegativeKeyword —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a negative keyword from a negative keyword list.

public delete(string $advertiserId, string $negativeKeywordListId, string $keywordValue[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_DisplayvideoEmpty

(negativeKeywords.delete)

Parameters
$advertiserId : string

Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

$negativeKeywordListId : string

Required. The ID of the parent negative keyword list to which the negative keyword belongs.

$keywordValue : string

Required. The keyword value of the negative keyword to delete.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DisplayVideo_DisplayvideoEmpty —

listAdvertisersNegativeKeywordListsNegativeKeywords()

Lists negative keywords in a negative keyword list.

public listAdvertisersNegativeKeywordListsNegativeKeywords(string $advertiserId, string $negativeKeywordListId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_ListNegativeKeywordsResponse

(negativeKeywords.listAdvertisersNegativeKeywordListsNegativeKeywords)

Parameters
$advertiserId : string

Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.

$negativeKeywordListId : string

Required. The ID of the parent negative keyword list to which the requested negative keywords belong.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string orderBy Field by which to sort the list. Acceptable values are: * keywordValue (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: keywordValue desc.

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 ListNegativeKeywords method. If not specified, the first page of results will be returned.

opt_param

string filter Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keyword currently can only contain at most one * restriction. * A restriction has the form of {field} {operator} {value}. * The operator must be CONTAINS (:). * Supported fields: - keywordValue Examples: * All negative keywords for which the keyword value contains "google": keywordValue : "google"

opt_param

int pageSize Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

Return values
Google_Service_DisplayVideo_ListNegativeKeywordsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results