class AdvertisersNegativeKeywordLists extends Resource (View source)

The "negativeKeywordLists" collection of methods.

Typical usage is:

 $displayvideoService = new Google\Service\DisplayVideo(...);
 $negativeKeywordLists = $displayvideoService->advertisers_negativeKeywordLists;

Methods

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

Creates a new negative keyword list. Returns the newly created negative keyword list if successful. (negativeKeywordLists.create)

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

Deletes a negative keyword list given an advertiser ID and a negative keyword list ID. (negativeKeywordLists.delete)

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

Gets a negative keyword list given an advertiser ID and a negative keyword list ID. (negativeKeywordLists.get)

listAdvertisersNegativeKeywordLists(string $advertiserId, array $optParams = [])

Lists negative keyword lists based on a given advertiser id.

patch(string $advertiserId, string $negativeKeywordListId, NegativeKeywordList $postBody, array $optParams = [])

Updates a negative keyword list. Returns the updated negative keyword list if successful. (negativeKeywordLists.patch)

Details

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

Creates a new negative keyword list. Returns the newly created negative keyword list if successful. (negativeKeywordLists.create)

Parameters

string $advertiserId

Required. The ID of the DV360 advertiser to which the negative keyword list will belong.

NegativeKeywordList $postBody
array $optParams

Optional parameters.

Return Value

NegativeKeywordList

Exceptions

Exception

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

Deletes a negative keyword list given an advertiser ID and a negative keyword list ID. (negativeKeywordLists.delete)

Parameters

string $advertiserId

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

string $negativeKeywordListId

Required. The ID of the negative keyword list to delete.

array $optParams

Optional parameters.

Return Value

DisplayvideoEmpty

Exceptions

Exception

NegativeKeywordList get(string $advertiserId, string $negativeKeywordListId, array $optParams = [])

Gets a negative keyword list given an advertiser ID and a negative keyword list ID. (negativeKeywordLists.get)

Parameters

string $advertiserId

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

string $negativeKeywordListId

Required. The ID of the negative keyword list to fetch.

array $optParams

Optional parameters.

Return Value

NegativeKeywordList

Exceptions

Exception

ListNegativeKeywordListsResponse listAdvertisersNegativeKeywordLists(string $advertiserId, array $optParams = [])

Lists negative keyword lists based on a given advertiser id.

(negativeKeywordLists.listAdvertisersNegativeKeywordLists)

Parameters

string $advertiserId

Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.

array $optParams

Optional parameters.

Return Value

ListNegativeKeywordListsResponse

Exceptions

Exception

NegativeKeywordList patch(string $advertiserId, string $negativeKeywordListId, NegativeKeywordList $postBody, array $optParams = [])

Updates a negative keyword list. Returns the updated negative keyword list if successful. (negativeKeywordLists.patch)

Parameters

string $advertiserId

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

string $negativeKeywordListId

Output only. The unique ID of the negative keyword list. Assigned by the system.

NegativeKeywordList $postBody
array $optParams

Optional parameters.

Return Value

NegativeKeywordList

Exceptions

Exception