1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DisplayVideo
  7. \
  8. Resource
  9. \
  10. AdvertisersNegativeKeywordListsNegativeKeywords

AdvertisersNegativeKeywordListsNegativeKeywords

class AdvertisersNegativeKeywordListsNegativeKeywords extends Resource (View source)

The "negativeKeywords" collection of methods.

Typical usage is:

 $displayvideoService = new Google\Service\DisplayVideo(...);
 $negativeKeywords = $displayvideoService->advertisers_negativeKeywordLists_negativeKeywords;

Methods

BulkEditNegativeKeywordsResponse
bulkEdit(string $advertiserId, string $negativeKeywordListId, BulkEditNegativeKeywordsRequest $postBody, array $optParams = [])

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)

NegativeKeyword
create(string $advertiserId, string $negativeKeywordListId, NegativeKeyword $postBody, array $optParams = [])

Creates a negative keyword in a negative keyword list.

DisplayvideoEmpty
delete(string $advertiserId, string $negativeKeywordListId, string $keywordValue, array $optParams = [])

Deletes a negative keyword from a negative keyword list.

ListNegativeKeywordsResponse
listAdvertisersNegativeKeywordListsNegativeKeywords(string $advertiserId, string $negativeKeywordListId, array $optParams = [])

Lists negative keywords in a negative keyword list.

ReplaceNegativeKeywordsResponse
replace(string $advertiserId, string $negativeKeywordListId, ReplaceNegativeKeywordsRequest $postBody, array $optParams = [])

Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.

Details

at line 56
BulkEditNegativeKeywordsResponse bulkEdit(string $advertiserId, string $negativeKeywordListId, BulkEditNegativeKeywordsRequest $postBody, array $optParams = [])

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)

Parameters

string $advertiserId

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

Required. The ID of the parent negative keyword list to which the negative keywords belong.
BulkEditNegativeKeywordsRequest $postBody
array $optParams

Optional parameters.

Return Value

BulkEditNegativeKeywordsResponse

Exceptions

Exception

at line 75
NegativeKeyword create(string $advertiserId, string $negativeKeywordListId, NegativeKeyword $postBody, array $optParams = [])

Creates a negative keyword in a negative keyword list.

(negativeKeywords.create)

Parameters

string $advertiserId

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

Required. The ID of the parent negative keyword list in which the negative keyword will be created.
NegativeKeyword $postBody
array $optParams

Optional parameters.

Return Value

NegativeKeyword

Exceptions

Exception

at line 95
DisplayvideoEmpty delete(string $advertiserId, string $negativeKeywordListId, string $keywordValue, array $optParams = [])

Deletes a negative keyword from a negative keyword list.

(negativeKeywords.delete)

Parameters

string $advertiserId

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

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

Required. The keyword value of the negative keyword to delete.
array $optParams

Optional parameters.

Return Value

DisplayvideoEmpty

Exceptions

Exception

at line 134
ListNegativeKeywordsResponse listAdvertisersNegativeKeywordListsNegativeKeywords(string $advertiserId, string $negativeKeywordListId, array $optParams = [])

Lists negative keywords in a negative keyword list.

(negativeKeywords.listAdvertisersNegativeKeywordListsNegativeKeywords)

Parameters

string $advertiserId

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

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

Optional parameters.

Return Value

ListNegativeKeywordsResponse

Exceptions

Exception

at line 155
ReplaceNegativeKeywordsResponse replace(string $advertiserId, string $negativeKeywordListId, ReplaceNegativeKeywordsRequest $postBody, array $optParams = [])

Replaces all negative keywords in a single negative keyword list. The operation will replace the keywords in a negative keyword list with keywords provided in ReplaceNegativeKeywordsRequest.new_negative_keywords.

(negativeKeywords.replace)

Parameters

string $advertiserId

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

Required. The ID of the parent negative keyword list to which the negative keywords belong.
ReplaceNegativeKeywordsRequest $postBody
array $optParams

Optional parameters.

Return Value

ReplaceNegativeKeywordsResponse

Exceptions

Exception